diff --git a/.buildkite/pipelines/pull_request/base.yml b/.buildkite/pipelines/pull_request/base.yml index 894f4c4368a3dd..4aa9a7a49fe233 100644 --- a/.buildkite/pipelines/pull_request/base.yml +++ b/.buildkite/pipelines/pull_request/base.yml @@ -173,6 +173,6 @@ steps: - command: .buildkite/scripts/steps/webpack_bundle_analyzer/build_and_upload.sh label: 'Build Webpack Bundle Analyzer reports' agents: - queue: n2-2 + queue: c2-4 key: webpack_bundle_analyzer timeout_in_minutes: 60 diff --git a/.buildkite/scripts/bootstrap.sh b/.buildkite/scripts/bootstrap.sh index 413c56e2e81093..34461ca6db1941 100755 --- a/.buildkite/scripts/bootstrap.sh +++ b/.buildkite/scripts/bootstrap.sh @@ -15,7 +15,7 @@ if ! yarn kbn bootstrap; then rm -rf node_modules echo "--- yarn install and bootstrap, attempt 2" - yarn kbn bootstrap + yarn kbn bootstrap --force-install fi if [[ "$DISABLE_BOOTSTRAP_VALIDATION" != "true" ]]; then diff --git a/.buildkite/scripts/build_kibana.sh b/.buildkite/scripts/build_kibana.sh index a7fbcc0ea4b92d..482f730284a94a 100755 --- a/.buildkite/scripts/build_kibana.sh +++ b/.buildkite/scripts/build_kibana.sh @@ -8,7 +8,7 @@ echo "--- Build Kibana Distribution" if [[ "${GITHUB_PR_LABELS:-}" == *"ci:build-all-platforms"* ]]; then node scripts/build --all-platforms --skip-os-packages elif [[ "${GITHUB_PR_LABELS:-}" == *"ci:build-os-packages"* ]]; then - node scripts/build --all-platforms + node scripts/build --all-platforms --docker-cross-compile else node scripts/build fi diff --git a/.buildkite/scripts/steps/artifacts/build.sh b/.buildkite/scripts/steps/artifacts/build.sh index 211bfddecd010f..db1faa184b35af 100644 --- a/.buildkite/scripts/steps/artifacts/build.sh +++ b/.buildkite/scripts/steps/artifacts/build.sh @@ -5,7 +5,7 @@ set -euo pipefail .buildkite/scripts/bootstrap.sh echo "--- Build Kibana Distribution" -node scripts/build --all-platforms --debug --skip-docker-cloud +node scripts/build --all-platforms --debug --docker-cross-compile --skip-docker-cloud echo "--- Build dependencies report" node scripts/licenses_csv_report --csv=target/dependencies_report.csv diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index 703029e49ca4ba..0afe38f88e46ba 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -598,6 +598,49 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "actions", + "id": "def-server.FindActionResult", + "type": "Interface", + "tags": [], + "label": "FindActionResult", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.FindActionResult", + "text": "FindActionResult" + }, + " extends ", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionResult", + "text": "ActionResult" + }, + "<", + "ActionTypeConfig", + ">" + ], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.FindActionResult.referencedByCount", + "type": "number", + "tags": [], + "label": "referencedByCount", + "description": [], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-server.PreConfiguredAction", @@ -866,7 +909,13 @@ "text": "ActionTypeExecutorResult" }, ">; getAll: () => Promise<", - "FindActionResult", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.FindActionResult", + "text": "FindActionResult" + }, "[]>; getBulk: (ids: string[]) => Promise<", { "pluginId": "actions", diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index d2c9ee775d5328..f4482b882e2e1a 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 125 | 0 | 125 | 11 | +| 127 | 0 | 127 | 10 | ## Server diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index f2d44ad5ee853c..6a905c58dd2d7d 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-03-15 +date: 2022-03-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/alerting.devdocs.json b/api_docs/alerting.devdocs.json index 3405c4e5916158..1506b960286a90 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -57,7 +57,7 @@ "section": "def-common.AlertAction", "text": "AlertAction" }, - "[]; throttle: string | null; alertTypeId: string; consumer: string; schedule: ", + "[]; throttle: string | null; consumer: string; alertTypeId: string; schedule: ", { "pluginId": "alerting", "scope": "common", @@ -81,7 +81,7 @@ "section": "def-common.AlertExecutionStatus", "text": "AlertExecutionStatus" }, - "; }" + "; snoozeEndTime?: Date | null | undefined; }" ], "path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts", "deprecated": false @@ -1904,8 +1904,8 @@ "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-server.PublicAlertingConfig", - "text": "PublicAlertingConfig" + "section": "def-server.AlertingRulesConfig", + "text": "AlertingRulesConfig" } ], "path": "x-pack/plugins/alerting/server/plugin.ts", @@ -2433,6 +2433,20 @@ ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.RuleType.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "RuleTypeConfig", + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -2529,6 +2543,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "alerting", + "id": "def-server.AlertingRulesConfig", + "type": "Type", + "tags": [], + "label": "AlertingRulesConfig", + "description": [], + "signature": [ + "{ readonly minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; }" + ], + "path": "x-pack/plugins/alerting/server/config.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-server.AlertInstanceContext", @@ -2651,20 +2679,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "alerting", - "id": "def-server.PublicAlertingConfig", - "type": "Type", - "tags": [], - "label": "PublicAlertingConfig", - "description": [], - "signature": [ - "{ readonly minimumScheduleInterval: string; }" - ], - "path": "x-pack/plugins/alerting/server/config.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "alerting", "id": "def-server.RulesClient", @@ -2775,7 +2789,11 @@ "section": "def-common.AlertSummary", "text": "AlertSummary" }, - ">; updateApiKey: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", + ">; getExecutionLogForRule: ({ id, dateStart, dateEnd, filter, page, perPage, sort, }: ", + "GetExecutionLogByIdParams", + ") => Promise<", + "IExecutionLogResult", + ">; updateApiKey: ({ id }: { id: string; }) => Promise; snooze: ({ id, snoozeEndTime, }: { id: string; snoozeEndTime: string | -1; }) => Promise; unsnooze: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", @@ -3540,6 +3558,19 @@ ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.Alert.snoozeEndTime", + "type": "CompoundType", + "tags": [], + "label": "snoozeEndTime", + "description": [], + "signature": [ + "Date | null | undefined" + ], + "path": "x-pack/plugins/alerting/common/alert.ts", + "deprecated": false } ], "initialIsOpen": false @@ -3648,6 +3679,19 @@ ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertAggregations.ruleSnoozedStatus", + "type": "Object", + "tags": [], + "label": "ruleSnoozedStatus", + "description": [], + "signature": [ + "{ snoozed: number; }" + ], + "path": "x-pack/plugins/alerting/common/alert.ts", + "deprecated": false } ], "initialIsOpen": false @@ -3670,7 +3714,7 @@ "label": "status", "description": [], "signature": [ - "\"error\" | \"unknown\" | \"pending\" | \"ok\" | \"active\"" + "\"error\" | \"unknown\" | \"warning\" | \"pending\" | \"ok\" | \"active\"" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false @@ -3747,6 +3791,27 @@ ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertExecutionStatus.warning", + "type": "Object", + "tags": [], + "label": "warning", + "description": [], + "signature": [ + "{ reason: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertExecutionStatusWarningReasons", + "text": "AlertExecutionStatusWarningReasons" + }, + "; message: string; } | undefined" + ], + "path": "x-pack/plugins/alerting/common/alert.ts", + "deprecated": false } ], "initialIsOpen": false @@ -4328,7 +4393,7 @@ "label": "state", "description": [], "signature": [ - "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; } & { metrics: { numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }; triggeredActions: { group?: string | undefined; id?: string | undefined; actionTypeId?: string | undefined; params?: { [x: string]: unknown; } | undefined; }[]; }" + "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; } & { metrics: { numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }; alertExecutionStore: { numberOfTriggeredActions?: number | undefined; triggeredActionsStatus?: string | undefined; }; }" ], "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", "deprecated": false @@ -4777,12 +4842,23 @@ "label": "AlertExecutionStatuses", "description": [], "signature": [ - "\"error\" | \"unknown\" | \"pending\" | \"ok\" | \"active\"" + "\"error\" | \"unknown\" | \"warning\" | \"pending\" | \"ok\" | \"active\"" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertExecutionStatusWarningReasons", + "type": "string", + "tags": [], + "label": "AlertExecutionStatusWarningReasons", + "description": [], + "path": "x-pack/plugins/alerting/common/alert.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceContext", @@ -5108,7 +5184,7 @@ "label": "RuleExecutionState", "description": [], "signature": [ - "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; } & { metrics: { numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }; triggeredActions: { group?: string | undefined; id?: string | undefined; actionTypeId?: string | undefined; params?: { [x: string]: unknown; } | undefined; }[]; }" + "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; } & { metrics: { numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }; alertExecutionStore: { numberOfTriggeredActions?: number | undefined; triggeredActionsStatus?: string | undefined; }; }" ], "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", "deprecated": false, @@ -5180,7 +5256,7 @@ "section": "def-common.AlertAction", "text": "AlertAction" }, - "[]; throttle: string | null; alertTypeId: string; consumer: string; schedule: ", + "[]; throttle: string | null; consumer: string; alertTypeId: string; schedule: ", { "pluginId": "alerting", "scope": "common", @@ -5204,7 +5280,7 @@ "section": "def-common.AlertExecutionStatus", "text": "AlertExecutionStatus" }, - "; }" + "; snoozeEndTime?: Date | null | undefined; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, @@ -5264,7 +5340,7 @@ "label": "AlertExecutionStatusValues", "description": [], "signature": [ - "readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]" + "readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\", \"warning\"]" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index c71dcab214ab50..3a8fa212dc877e 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-03-15 +date: 2022-03-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. --- @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 296 | 0 | 288 | 18 | +| 301 | 0 | 293 | 21 | ## Client diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index 3ef7e8a739f00e..fc375a97699827 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -731,7 +731,7 @@ "label": "APIEndpoint", "description": [], "signature": [ - "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/dynamic\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"POST /internal/apm/latency/overall_distribution\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/ux/client-metrics\" | \"GET /internal/apm/ux/page-load-distribution\" | \"GET /internal/apm/ux/page-load-distribution/breakdown\" | \"GET /internal/apm/ux/page-view-trends\" | \"GET /internal/apm/ux/services\" | \"GET /internal/apm/ux/visitor-breakdown\" | \"GET /internal/apm/ux/web-core-vitals\" | \"GET /internal/apm/ux/long-task-metrics\" | \"GET /internal/apm/ux/url-search\" | \"GET /internal/apm/ux/js-errors\" | \"GET /api/apm/observability_overview/has_rum_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/backend\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"GET /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/alerts\" | \"GET /internal/apm/services/{serviceName}/infrastructure\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/backends/top_backends\" | \"GET /internal/apm/backends/upstream_services\" | \"GET /internal/apm/backends/metadata\" | \"GET /internal/apm/backends/charts/latency\" | \"GET /internal/apm/backends/charts/throughput\" | \"GET /internal/apm/backends/charts/error_rate\" | \"POST /internal/apm/correlations/p_values\" | \"GET /internal/apm/correlations/field_candidates\" | \"POST /internal/apm/correlations/field_stats\" | \"GET /internal/apm/correlations/field_value_stats\" | \"POST /internal/apm/correlations/field_value_pairs\" | \"POST /internal/apm/correlations/significant_correlations\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\"" + "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/dynamic\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"POST /internal/apm/latency/overall_distribution\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/ux/client-metrics\" | \"GET /internal/apm/ux/page-load-distribution\" | \"GET /internal/apm/ux/page-load-distribution/breakdown\" | \"GET /internal/apm/ux/page-view-trends\" | \"GET /internal/apm/ux/services\" | \"GET /internal/apm/ux/visitor-breakdown\" | \"GET /internal/apm/ux/web-core-vitals\" | \"GET /internal/apm/ux/long-task-metrics\" | \"GET /internal/apm/ux/url-search\" | \"GET /internal/apm/ux/js-errors\" | \"GET /api/apm/observability_overview/has_rum_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/backend\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"GET /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/infrastructure\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/backends/top_backends\" | \"GET /internal/apm/backends/upstream_services\" | \"GET /internal/apm/backends/metadata\" | \"GET /internal/apm/backends/charts/latency\" | \"GET /internal/apm/backends/charts/throughput\" | \"GET /internal/apm/backends/charts/error_rate\" | \"POST /internal/apm/correlations/p_values\" | \"GET /internal/apm/correlations/field_candidates\" | \"POST /internal/apm/correlations/field_stats\" | \"GET /internal/apm/correlations/field_value_stats\" | \"POST /internal/apm/correlations/field_value_pairs\" | \"POST /internal/apm/correlations/significant_correlations\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\"" ], "path": "x-pack/plugins/apm/server/routes/apm_routes/get_global_apm_server_route_repository.ts", "deprecated": false, @@ -1015,7 +1015,9 @@ }, ", { latencyCorrelations: ", "LatencyCorrelation", - "[]; ccsWarning: boolean; totalDocCount: number; }, ", + "[]; ccsWarning: boolean; totalDocCount: number; fallbackResult?: ", + "LatencyCorrelation", + " | undefined; }, ", "APMRouteCreateOptions", ">; \"POST /internal/apm/correlations/field_value_pairs\": ", "ServerRoute", @@ -1291,7 +1293,9 @@ }, ", { failedTransactionsCorrelations: ", "FailedTransactionsCorrelation", - "[]; ccsWarning: boolean; }, ", + "[]; ccsWarning: boolean; fallbackResult?: ", + "FailedTransactionsCorrelation", + " | undefined; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/backends/charts/error_rate\": ", "ServerRoute", @@ -3295,50 +3299,6 @@ }, ", { serviceInfrastructure: { containerIds: string[]; hostNames: string[]; }; }, ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/alerts\": ", - "ServerRoute", - "<\"GET /internal/apm/services/{serviceName}/alerts\", ", - "TypeC", - "<{ path: ", - "TypeC", - "<{ serviceName: ", - "StringC", - "; }>; query: ", - "IntersectionC", - "<[", - "TypeC", - "<{ start: ", - "Type", - "; end: ", - "Type", - "; }>, ", - "TypeC", - "<{ environment: ", - "UnionC", - "<[", - "LiteralC", - "<\"ENVIRONMENT_NOT_DEFINED\">, ", - "LiteralC", - "<\"ENVIRONMENT_ALL\">, ", - "BrandC", - "<", - "StringC", - ", ", - "NonEmptyStringBrand", - ">]>; }>, ", - "TypeC", - "<{ transactionType: ", - "StringC", - "; }>]>; }>, ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", { alerts: Partial>[]; }, ", - "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/profiling/statistics\": ", "ServerRoute", "<\"GET /internal/apm/services/{serviceName}/profiling/statistics\", ", diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index fc5090edb7babc..57311e701350ef 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index d85129497e5549..d264c993849357 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-03-15 +date: 2022-03-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 0e57f3dc2e63b6..4e9f494e826d33 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-03-15 +date: 2022-03-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 174fea8e354c23..b4df6fb8b2f401 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-03-15 +date: 2022-03-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 115538ecfe5dd0..853012159e20db 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -716,11 +716,7 @@ "label": "hooks", "description": [], "signature": [ - "{ getUseCasesAddToNewCaseFlyout: (props: ", - "CreateCaseFlyoutProps", - ") => { open: () => void; close: () => void; }; getUseCasesAddToExistingCaseModal: (props: ", - "AllCasesSelectorModalProps", - ") => { open: () => void; close: () => void; }; }" + "{ getUseCasesAddToNewCaseFlyout: (props: AddToNewCaseFlyoutProps) => { open: () => void; close: () => void; }; getUseCasesAddToExistingCaseModal: (props: AddToExistingFlyoutProps) => { open: () => void; close: () => void; }; }" ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false @@ -1270,7 +1266,7 @@ "label": "CasesFeatures", "description": [], "signature": [ - "{ alerts?: { sync: boolean; } | undefined; metrics?: ", + "{ alerts?: { sync?: boolean | undefined; enabled?: boolean | undefined; } | undefined; metrics?: ", "CaseMetricsFeature", "[] | undefined; }" ], diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index b88fd72852246a..8d6c10f212118b 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-03-15 +date: 2022-03-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.mdx b/api_docs/charts.mdx index e03cb4690762f9..9b5f5c8a161ce7 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-03-15 +date: 2022-03-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 c56a338c3089ce..7c59d31fb1ed59 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-03-15 +date: 2022-03-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 5f991959da8958..ceb52e2ee8fbf2 100644 --- a/api_docs/cloud_security_posture.devdocs.json +++ b/api_docs/cloud_security_posture.devdocs.json @@ -40,7 +40,114 @@ "interfaces": [], "enums": [], "misc": [], - "objects": [], + "objects": [ + { + "parentPluginId": "cloudSecurityPosture", + "id": "def-server.cspRuleTemplateAssetType", + "type": "Object", + "tags": [], + "label": "cspRuleTemplateAssetType", + "description": [], + "path": "x-pack/plugins/cloud_security_posture/server/saved_objects/csp_rule_template.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "cloudSecurityPosture", + "id": "def-server.cspRuleTemplateAssetType.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/cloud_security_posture/server/saved_objects/csp_rule_template.ts", + "deprecated": false + }, + { + "parentPluginId": "cloudSecurityPosture", + "id": "def-server.cspRuleTemplateAssetType.hidden", + "type": "boolean", + "tags": [], + "label": "hidden", + "description": [], + "signature": [ + "false" + ], + "path": "x-pack/plugins/cloud_security_posture/server/saved_objects/csp_rule_template.ts", + "deprecated": false + }, + { + "parentPluginId": "cloudSecurityPosture", + "id": "def-server.cspRuleTemplateAssetType.management", + "type": "Object", + "tags": [], + "label": "management", + "description": [], + "path": "x-pack/plugins/cloud_security_posture/server/saved_objects/csp_rule_template.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "cloudSecurityPosture", + "id": "def-server.cspRuleTemplateAssetType.management.importableAndExportable", + "type": "boolean", + "tags": [], + "label": "importableAndExportable", + "description": [], + "signature": [ + "true" + ], + "path": "x-pack/plugins/cloud_security_posture/server/saved_objects/csp_rule_template.ts", + "deprecated": false + }, + { + "parentPluginId": "cloudSecurityPosture", + "id": "def-server.cspRuleTemplateAssetType.management.visibleInManagement", + "type": "boolean", + "tags": [], + "label": "visibleInManagement", + "description": [], + "signature": [ + "true" + ], + "path": "x-pack/plugins/cloud_security_posture/server/saved_objects/csp_rule_template.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "cloudSecurityPosture", + "id": "def-server.cspRuleTemplateAssetType.namespaceType", + "type": "string", + "tags": [], + "label": "namespaceType", + "description": [], + "signature": [ + "\"agnostic\"" + ], + "path": "x-pack/plugins/cloud_security_posture/server/saved_objects/csp_rule_template.ts", + "deprecated": false + }, + { + "parentPluginId": "cloudSecurityPosture", + "id": "def-server.cspRuleTemplateAssetType.mappings", + "type": "Object", + "tags": [], + "label": "mappings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsTypeMappingDefinition", + "text": "SavedObjectsTypeMappingDefinition" + } + ], + "path": "x-pack/plugins/cloud_security_posture/server/saved_objects/csp_rule_template.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], "setup": { "parentPluginId": "cloudSecurityPosture", "id": "def-server.CspServerPluginSetup", diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index 42098477a9bced..b51d2afeb767bd 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 6 | 0 | 6 | 0 | +| 14 | 0 | 14 | 0 | ## Client @@ -36,6 +36,9 @@ Contact [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-pos ### Start +### Objects + + ## Common ### Consts, variables and types diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 09eaf8b55bea62..38b6093b24747d 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/controls.devdocs.json index 829bd4e8b7891a..65ebe06c60961e 100644 --- a/api_docs/controls.devdocs.json +++ b/api_docs/controls.devdocs.json @@ -1946,6 +1946,19 @@ "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "children": [ + { + "parentPluginId": "controls", + "id": "def-public.ControlGroupInput.chainingSystem", + "type": "CompoundType", + "tags": [], + "label": "chainingSystem", + "description": [], + "signature": [ + "\"HIERARCHICAL\" | \"NONE\"" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + }, { "parentPluginId": "controls", "id": "def-public.ControlGroupInput.defaultControlWidth", @@ -2531,7 +2544,32 @@ }, "common": { "classes": [], - "functions": [], + "functions": [ + { + "parentPluginId": "controls", + "id": "def-common.getDefaultControlGroupInput", + "type": "Function", + "tags": [], + "label": "getDefaultControlGroupInput", + "description": [], + "signature": [ + "() => Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.ControlGroupInput", + "text": "ControlGroupInput" + }, + ", \"id\">" + ], + "path": "src/plugins/controls/common/control_group/control_group_constants.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], "interfaces": [ { "parentPluginId": "controls", @@ -2562,6 +2600,19 @@ "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "children": [ + { + "parentPluginId": "controls", + "id": "def-common.ControlGroupInput.chainingSystem", + "type": "CompoundType", + "tags": [], + "label": "chainingSystem", + "description": [], + "signature": [ + "\"HIERARCHICAL\" | \"NONE\"" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + }, { "parentPluginId": "controls", "id": "def-common.ControlGroupInput.defaultControlWidth", diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 4ab5c0d8de4423..ab0bdaa1562c89 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 130 | 0 | 124 | 4 | +| 133 | 0 | 127 | 4 | ## Client @@ -36,6 +36,9 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese ## Common +### Functions + + ### Interfaces diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index ef00b54e3d2dc1..d3e55ebe7e3922 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -965,6 +965,7 @@ ], "path": "src/core/public/index.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "visTypeVega", @@ -1322,6 +1323,7 @@ ], "path": "src/core/public/index.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "monitoring", @@ -1334,6 +1336,10 @@ { "plugin": "visTypeVega", "path": "src/plugins/vis_types/vega/public/plugin.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/target/types/public/data_model/search_api.d.ts" } ] } @@ -5997,7 +6003,7 @@ "\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": [ - "\"conflict\" | \"aliasMatch\" | \"exactMatch\"" + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" ], "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false @@ -6009,13 +6015,28 @@ "tags": [], "label": "alias_target_id", "description": [ - "\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`." + "\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-public.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 @@ -7564,6 +7585,18 @@ "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfig.maxSockets", + "type": "number", + "tags": [], + "label": "maxSockets", + "description": [ + "\nThe maximum number of sockets that can be used for communications with elasticsearch." + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-server.ElasticsearchConfig.compression", @@ -7786,7 +7819,7 @@ "label": "rawConfig", "description": [], "signature": [ - "Readonly<{ username?: string | undefined; password?: string | undefined; serviceAccountToken?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; healthCheck: Readonly<{} & { delay: moment.Duration; }>; hosts: string | string[]; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; compression: boolean; requestHeadersWhitelist: string | string[]; customHeaders: Record; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; logQueries: boolean; apiVersion: string; ignoreVersionMismatch: boolean; skipStartupConnectionCheck: boolean; }>" + "Readonly<{ username?: string | undefined; password?: string | undefined; serviceAccountToken?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; healthCheck: Readonly<{} & { delay: moment.Duration; }>; hosts: string | string[]; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; maxSockets: number; compression: boolean; requestHeadersWhitelist: string | string[]; customHeaders: Record; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; logQueries: boolean; apiVersion: string; ignoreVersionMismatch: boolean; skipStartupConnectionCheck: boolean; }>" ], "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false, @@ -8052,7 +8085,17 @@ ], "path": "src/core/server/plugins/types.ts", "deprecated": true, - "references": [], + "removeBy": "8.8.0", + "references": [ + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/target/types/server/plugin.d.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/target/types/server/plugin.d.ts" + } + ], "children": [ { "parentPluginId": "core", @@ -17533,6 +17576,7 @@ ], "path": "src/core/server/metrics/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "monitoring", @@ -23284,7 +23328,7 @@ "section": "def-server.ElasticsearchConfig", "text": "ElasticsearchConfig" }, - ", \"username\" | \"hosts\" | \"password\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\" | \"customHeaders\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" + ", \"username\" | \"hosts\" | \"password\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\" | \"customHeaders\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" ], "path": "src/core/server/elasticsearch/client/client_config.ts", "deprecated": false, diff --git a/api_docs/core.mdx b/api_docs/core.mdx index ee8ea3e18f2d09..9c7cd4378271ed 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 2370 | 15 | 969 | 33 | +| 2374 | 15 | 969 | 33 | ## Client diff --git a/api_docs/core_application.devdocs.json b/api_docs/core_application.devdocs.json index cf597875b4937b..481db4d605e5c6 100644 --- a/api_docs/core_application.devdocs.json +++ b/api_docs/core_application.devdocs.json @@ -1371,6 +1371,7 @@ ], "path": "src/core/public/application/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "management", @@ -1384,9 +1385,21 @@ "plugin": "security", "path": "x-pack/plugins/security/public/authentication/logout/logout_app.test.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/target/types/public/applications/fleet/index.d.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/target/types/public/applications/integrations/index.d.ts" + }, { "plugin": "kibanaOverview", "path": "src/plugins/kibana_overview/public/application.tsx" + }, + { + "plugin": "management", + "path": "src/plugins/management/target/types/public/application.d.ts" } ] }, @@ -1414,6 +1427,7 @@ ], "path": "src/core/public/application/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "visualizations", @@ -1475,9 +1489,41 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/app/index.tsx" }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/render_app.d.ts" + }, { "plugin": "security", "path": "x-pack/plugins/security/public/authentication/logout/logout_app.test.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_page.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/types.d.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/visualize_app/app.d.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/visualize_app/index.d.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/visualize_app/components/visualize_editor_common.d.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/visualize_app/components/visualize_top_nav.d.ts" } ], "children": [ @@ -1889,6 +1935,7 @@ ], "path": "src/core/public/application/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "securitySolution", diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index 3bd1b91479dddb..dd9fd27275fdb6 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 2370 | 15 | 969 | 33 | +| 2374 | 15 | 969 | 33 | ## Client diff --git a/api_docs/core_chrome.devdocs.json b/api_docs/core_chrome.devdocs.json index 2ddd5f2792222a..6d9e4df9f856b2 100644 --- a/api_docs/core_chrome.devdocs.json +++ b/api_docs/core_chrome.devdocs.json @@ -1866,8 +1866,11 @@ "label": "ChromeBreadcrumb", "description": [], "signature": [ + "React.HTMLAttributes & ", "CommonProps", - " & { text: React.ReactNode; href?: string | undefined; onClick?: React.MouseEventHandler | undefined; truncate?: boolean | undefined; 'aria-current'?: boolean | \"date\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; }" + " & { href?: string | undefined; onClick?: React.MouseEventHandler | undefined; text: React.ReactNode; truncate?: boolean | undefined; color?: ", + "EuiLinkColor", + " | undefined; 'aria-current'?: boolean | \"date\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; }" ], "path": "src/core/public/chrome/types.ts", "deprecated": false, diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index fb42987c5b75e5..be217167a8488d 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 2370 | 15 | 969 | 33 | +| 2374 | 15 | 969 | 33 | ## Client diff --git a/api_docs/core_http.devdocs.json b/api_docs/core_http.devdocs.json index 13ec591282a570..561de33cab4a32 100644 --- a/api_docs/core_http.devdocs.json +++ b/api_docs/core_http.devdocs.json @@ -1811,6 +1811,7 @@ ], "path": "src/core/public/http/types.ts", "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", "references": [ { "plugin": "ml", @@ -1836,6 +1837,7 @@ ], "path": "src/core/public/http/types.ts", "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", "references": [] }, { diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index 0720129750034d..995f67b0810bd4 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http title: "core.http" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.http plugin -date: 2022-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] warning: This 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 | |-------------------|-----------|------------------------|-----------------| -| 2370 | 15 | 969 | 33 | +| 2374 | 15 | 969 | 33 | ## Client diff --git a/api_docs/core_saved_objects.devdocs.json b/api_docs/core_saved_objects.devdocs.json index 27ca257aa9744b..e84daeb0b7d4b9 100644 --- a/api_docs/core_saved_objects.devdocs.json +++ b/api_docs/core_saved_objects.devdocs.json @@ -1068,7 +1068,7 @@ "\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": [ - "\"conflict\" | \"aliasMatch\" | \"exactMatch\"" + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" ], "path": "src/core/public/saved_objects/types.ts", "deprecated": false @@ -1080,13 +1080,28 @@ "tags": [], "label": "alias_target_id", "description": [ - "\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`." + "\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/public/saved_objects/types.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": "src/core/public/saved_objects/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -8771,7 +8786,7 @@ "\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": [ - "(namespace: string, type: string, id: string) => string" + "(namespace: string | undefined, type: string, id: string) => string" ], "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, @@ -8786,11 +8801,11 @@ "- The namespace of the saved object" ], "signature": [ - "string" + "string | undefined" ], "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "core", @@ -13465,6 +13480,7 @@ ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "lens", @@ -14143,7 +14159,7 @@ "\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": [ - "\"conflict\" | \"aliasMatch\" | \"exactMatch\"" + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" ], "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false @@ -14155,13 +14171,28 @@ "tags": [], "label": "alias_target_id", "description": [ - "\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`." + "\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 diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index 6e7d0356b0c1e1..1fe4aa1869bd5d 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-03-15 +date: 2022-03-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,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 | |-------------------|-----------|------------------------|-----------------| -| 2370 | 15 | 969 | 33 | +| 2374 | 15 | 969 | 33 | ## Client diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index dcf49061e7b414..3eafb18871dcca 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-03-15 +date: 2022-03-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 343582e8d5f91e..a7a90e41d4b05a 100644 --- a/api_docs/dashboard.devdocs.json +++ b/api_docs/dashboard.devdocs.json @@ -1219,7 +1219,7 @@ "label": "controlGroupInput", "description": [], "signature": [ - "DashboardControlGroupInput", + "DashboardContainerControlGroupInput", " | undefined" ], "path": "src/plugins/dashboard/public/types.ts", @@ -1907,12 +1907,12 @@ { "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.outcome", - "type": "string", + "type": "CompoundType", "tags": [], "label": "outcome", "description": [], "signature": [ - "string | undefined" + "\"exactMatch\" | \"aliasMatch\" | \"conflict\" | undefined" ], "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "deprecated": false @@ -1930,6 +1930,19 @@ "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "deprecated": false }, + { + "parentPluginId": "dashboard", + "id": "def-public.DashboardSavedObject.aliasPurpose", + "type": "CompoundType", + "tags": [], + "label": "aliasPurpose", + "description": [], + "signature": [ + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + ], + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "deprecated": false + }, { "parentPluginId": "dashboard", "id": "def-public.DashboardSavedObject.controlGroupInput", @@ -2434,9 +2447,8 @@ "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, - ", \"id\">) => Omit<", - "RawControlGroupAttributes", - ", \"id\">" + ", \"id\">) => ", + "RawControlGroupAttributes" ], "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", "deprecated": false, @@ -2475,14 +2487,20 @@ "label": "getDefaultDashboardControlGroupInput", "description": [], "signature": [ - "() => { controlStyle: ", - "ControlStyle", - "; panels: {}; }" + "() => Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.ControlGroupInput", + "text": "ControlGroupInput" + }, + ", \"id\">" ], "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", "deprecated": false, - "children": [], "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -2668,9 +2686,9 @@ "label": "rawAttributesToControlGroupInput", "description": [], "signature": [ - "(rawControlGroupAttributes: Omit<", + "(rawControlGroupAttributes: ", "RawControlGroupAttributes", - ", \"id\">) => Omit<", + ") => Omit<", { "pluginId": "controls", "scope": "common", @@ -2686,14 +2704,12 @@ { "parentPluginId": "dashboard", "id": "def-common.rawAttributesToControlGroupInput.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "rawControlGroupAttributes", "description": [], "signature": [ - "Omit<", - "RawControlGroupAttributes", - ", \"id\">" + "RawControlGroupAttributes" ], "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", "deprecated": false, @@ -2747,11 +2763,11 @@ "label": "serializableToRawAttributes", "description": [], "signature": [ - "(controlGroupInput: ", + "(serializable: ", "SerializableRecord", ") => Omit<", "RawControlGroupAttributes", - ", \"id\">" + ", \"type\" | \"id\">" ], "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", "deprecated": false, @@ -2761,7 +2777,7 @@ "id": "def-common.serializableToRawAttributes.$1", "type": "Object", "tags": [], - "label": "controlGroupInput", + "label": "serializable", "description": [], "signature": [ "SerializableRecord" diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 6e2c76eca30a6a..0c083d76e254d8 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 150 | 0 | 148 | 15 | +| 151 | 0 | 149 | 14 | ## Client diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index f50a19c8c27b30..658e0d1100ebff 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-03-15 +date: 2022-03-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 1e655838a75093..6b0ed841f01970 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -2664,136 +2664,28 @@ "path": "src/plugins/data_views/common/index.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts" }, { "plugin": "ux", @@ -2804,60 +2696,28 @@ "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { "plugin": "ux", @@ -2879,10 +2739,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/types.ts" @@ -2915,110 +2771,6 @@ "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" - }, { "plugin": "graph", "path": "x-pack/plugins/graph/public/types/app_state.ts" @@ -3107,70 +2859,6 @@ "plugin": "graph", "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, { "plugin": "uptime", "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" @@ -3219,6 +2907,22 @@ "plugin": "graph", "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" + }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" @@ -3229,171 +2933,275 @@ }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" }, { "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" }, { "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" }, { "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" + "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" }, { "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" + "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" }, { "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "dataViews", @@ -3449,76 +3257,32 @@ "path": "src/plugins/data_views/common/index.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "dataViews", @@ -3714,344 +3478,420 @@ }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.IndexPatternsService", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsService", - "description": [], - "signature": [ + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, - " extends ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" + }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" }, { "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + } + ], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.IndexPatternsService", + "type": "Class", + "tags": [ + "deprecated" + ], + "label": "IndexPatternsService", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsService", + "text": "DataViewsService" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/index.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/public/index.ts" } ], "children": [], @@ -5093,38 +4933,104 @@ "functions": [ { "parentPluginId": "data", - "id": "def-public.extractReferences", + "id": "def-public.calculateBounds", "type": "Function", "tags": [], - "label": "extractReferences", + "label": "calculateBounds", "description": [], "signature": [ - "(state: ", + "(timeRange: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" }, - ") => [", + ", options: CalculateBoundsOptions) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" - }, - ", ", - "SavedObjectReference", - "[]]" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + } ], - "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.extractReferences.$1", + "id": "def-public.calculateBounds.$1", + "type": "Object", + "tags": [], + "label": "timeRange", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.calculateBounds.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "CalculateBoundsOptions" + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.extractReferences", + "type": "Function", + "tags": [], + "label": "extractReferences", + "description": [], + "signature": [ + "(state: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" + }, + ") => [", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" + }, + ", ", + "SavedObjectReference", + "[]]" + ], + "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.extractReferences.$1", "type": "Object", "tags": [], "label": "state", @@ -5213,6 +5119,88 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-public.flattenHit", + "type": "Function", + "tags": [], + "label": "flattenHit", + "description": [ + "\nFlattens an individual hit (from an ES response) into an object. This will\ncreate flattened field names, like `user.name`.\n" + ], + "signature": [ + "(hit: Hit, indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined, params: TabifyDocsOptions | undefined) => Record" + ], + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.flattenHit.$1", + "type": "CompoundType", + "tags": [], + "label": "hit", + "description": [ + "The hit from an ES reponse's hits.hits[]" + ], + "signature": [ + "Hit" + ], + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.flattenHit.$2", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [ + "The index pattern for the requested index if available." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-public.flattenHit.$3", + "type": "Object", + "tags": [], + "label": "params", + "description": [ + "Parameters how to flatten the hit" + ], + "signature": [ + "TabifyDocsOptions | undefined" + ], + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-public.getEsQueryConfig", @@ -5817,6 +5805,92 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.tabifyAggResponse", + "type": "Function", + "tags": [], + "label": "tabifyAggResponse", + "description": [ + "\nSets up the ResponseWriter and kicks off bucket collection." + ], + "signature": [ + "(aggConfigs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + ", esResponse: Record, respOpts: Partial<", + "TabbedResponseWriterOptions", + "> | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.tabifyAggResponse.$1", + "type": "Object", + "tags": [], + "label": "aggConfigs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.tabifyAggResponse.$2", + "type": "Object", + "tags": [], + "label": "esResponse", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.tabifyAggResponse.$3", + "type": "Object", + "tags": [], + "label": "respOpts", + "description": [], + "signature": [ + "Partial<", + "TabbedResponseWriterOptions", + "> | undefined" + ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [ @@ -8325,159 +8399,71 @@ }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts" }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/server/utils.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/server/utils.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/server/utils.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/utils.test.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/utils.test.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/fields/fields.mocks.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/fields/fields.mocks.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, + "plugin": "dataViews", + "path": "src/plugins/data_views/common/fields/fields.mocks.ts" + } + ], + "children": [ { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" + "parentPluginId": "data", + "id": "def-public.IFieldType.count", + "type": "number", + "tags": [], + "label": "count", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/fields/types.ts", + "deprecated": false }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" - } - ], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.IFieldType.count", - "type": "number", - "tags": [], - "label": "count", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.IFieldType.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "parentPluginId": "data", + "id": "def-public.IFieldType.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/fields/types.ts", + "deprecated": false }, { "parentPluginId": "data", @@ -8780,64 +8766,20 @@ "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/services/es_index_service.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/services/es_index_service.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/server/routes/api/transforms.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/alerts/components/param_details_form/use_derived_index_pattern.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/server/routes/api/transforms.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/alerts/components/param_details_form/use_derived_index_pattern.d.ts" } ], "children": [ @@ -9599,150 +9541,327 @@ }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields", + "id": "def-public.SavedObject", "type": "Interface", "tags": [], - "label": "SearchSourceFields", - "description": [ - "\nsearch source fields" + "label": "SavedObject", + "description": [], + "signature": [ + "SavedObject", + "" ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSourceFields.type", + "id": "def-public.SavedObject.id", "type": "string", "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields.query", - "type": "Object", + "id": "def-public.SavedObject.type", + "type": "string", "tags": [], - "label": "query", + "label": "type", "description": [ - "\n{@link Query}" - ], - "signature": [ - "Query", - " | undefined" + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields.filter", - "type": "CompoundType", + "id": "def-public.SavedObject.version", + "type": "string", "tags": [], - "label": "filter", + "label": "version", "description": [ - "\n{@link Filter}" + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." ], "signature": [ - "Filter", - " | ", - "Filter", - "[] | (() => ", - "Filter", - " | ", - "Filter", - "[] | undefined) | undefined" + "string | undefined" ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields.sort", - "type": "CompoundType", + "id": "def-public.SavedObject.updated_at", + "type": "string", "tags": [], - "label": "sort", + "label": "updated_at", "description": [ - "\n{@link EsQuerySortValue}" + "Timestamp of the last time this document had been updated." ], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsQuerySortValue", - "text": "EsQuerySortValue" - }, - " | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsQuerySortValue", - "text": "EsQuerySortValue" - }, - "[] | undefined" + "string | undefined" ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields.highlight", - "type": "Any", + "id": "def-public.SavedObject.error", + "type": "Object", "tags": [], - "label": "highlight", + "label": "error", "description": [], "signature": [ - "any" + "SavedObjectError", + " | undefined" ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields.highlightAll", - "type": "CompoundType", + "id": "def-public.SavedObject.attributes", + "type": "Uncategorized", "tags": [], - "label": "highlightAll", - "description": [], + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], "signature": [ - "boolean | undefined" + "T" ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields.trackTotalHits", - "type": "CompoundType", + "id": "def-public.SavedObject.references", + "type": "Array", "tags": [], - "label": "trackTotalHits", - "description": [], + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], "signature": [ - "number | boolean | undefined" + "SavedObjectReference", + "[]" ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields.aggs", - "type": "CompoundType", + "id": "def-public.SavedObject.migrationVersion", + "type": "Object", "tags": [], - "label": "aggs", + "label": "migrationVersion", "description": [ - "\n{@link AggConfigs}" + "{@inheritdoc SavedObjectsMigrationVersion}" ], "signature": [ - "object | ", - { - "pluginId": "data", - "scope": "common", + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SavedObject.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.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": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.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": "src/core/types/saved_objects.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields", + "type": "Interface", + "tags": [], + "label": "SearchSourceFields", + "description": [ + "\nsearch source fields" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [ + "\n{@link Query}" + ], + "signature": [ + "Query", + " | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [ + "\n{@link Filter}" + ], + "signature": [ + "Filter", + " | ", + "Filter", + "[] | (() => ", + "Filter", + " | ", + "Filter", + "[] | undefined) | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.sort", + "type": "CompoundType", + "tags": [], + "label": "sort", + "description": [ + "\n{@link EsQuerySortValue}" + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" + }, + "[] | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.highlight", + "type": "Any", + "tags": [], + "label": "highlight", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.highlightAll", + "type": "CompoundType", + "tags": [], + "label": "highlightAll", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.trackTotalHits", + "type": "CompoundType", + "tags": [], + "label": "trackTotalHits", + "description": [], + "signature": [ + "number | boolean | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.aggs", + "type": "CompoundType", + "tags": [], + "label": "aggs", + "description": [ + "\n{@link AggConfigs}" + ], + "signature": [ + "object | ", + { + "pluginId": "data", + "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" @@ -10009,6 +10128,19 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-public.FilterStateStore", + "type": "Enum", + "tags": [], + "label": "FilterStateStore", + "description": [ + "\r\n Filter,\r\nAn enum to denote whether a filter is specific to an application's context or whether it should be applied globally." + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-public.KBN_FIELD_TYPES", @@ -10247,248 +10379,48 @@ "label": "DataViewsContract", "description": [], "signature": [ - "{ create: (spec: ", + "DataViewsServicePublic" + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.ES_SEARCH_STRATEGY", + "type": "string", + "tags": [], + "label": "ES_SEARCH_STRATEGY", + "description": [], + "signature": [ + "\"es\"" + ], + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.EsaggsExpressionFunctionDefinition", + "type": "Type", + "tags": [], + "label": "EsaggsExpressionFunctionDefinition", + "description": [], + "signature": [ { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - ", skipFetchFields?: boolean) => Promise<", + "<\"esaggs\", Input, Arguments, Output, ", { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>; get: (id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; refreshFields: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ") => Promise; fieldArrayToMap: (fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - "; createAndSave: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; createSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; updateSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getCanSaveSync: () => boolean; }" - ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.ES_SEARCH_STRATEGY", - "type": "string", - "tags": [], - "label": "ES_SEARCH_STRATEGY", - "description": [], - "signature": [ - "\"es\"" - ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.EsaggsExpressionFunctionDefinition", - "type": "Type", - "tags": [], - "label": "EsaggsExpressionFunctionDefinition", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"esaggs\", Input, Arguments, Output, ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, "<", { @@ -10777,6 +10709,14 @@ "deprecated": true, "removeBy": "8.1", "references": [ + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" @@ -10894,12 +10834,12 @@ "path": "src/plugins/discover/public/application/context/services/context_state.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" }, { "plugin": "maps", @@ -10911,24 +10851,52 @@ }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.IAggConfig", - "type": "Type", - "tags": [ - "name", - "description" - ], - "label": "IAggConfig", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.IAggConfig", + "type": "Type", + "tags": [ + "name", + "description" + ], + "label": "IAggConfig", "description": [], "signature": [ { @@ -11087,14 +11055,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/lib/es_service.ts" @@ -11106,34 +11066,6 @@ { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_app.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_app.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" } ], "initialIsOpen": false @@ -11400,38 +11332,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable_factory.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable_factory.ts" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" @@ -11448,65 +11348,29 @@ "plugin": "graph", "path": "x-pack/plugins/graph/public/application.tsx" }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/plugin_services.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/plugin_services.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" } ], "initialIsOpen": false @@ -11867,18 +11731,6 @@ "deprecated": true, "removeBy": "8.1", "references": [ - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" @@ -11918,6 +11770,14 @@ { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/target/types/server/search/session/types.d.ts" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/target/types/server/search/session/types.d.ts" } ], "initialIsOpen": false @@ -13782,14 +13642,6 @@ { "plugin": "graph", "path": "x-pack/plugins/graph/public/components/search_bar.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" } ], "children": [ @@ -13948,16 +13800,7 @@ "path": "src/plugins/data/public/deprecated.ts", "deprecated": true, "removeBy": "8.1", - "references": [ - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - } - ], + "references": [], "children": [ { "parentPluginId": "data", @@ -15753,580 +15596,108 @@ "\ndata views service\n{@link DataViewsContract}" ], "signature": [ - "{ create: (spec: ", + "DataViewsServicePublic" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.datatableUtilities", + "type": "Object", + "tags": [], + "label": "datatableUtilities", + "description": [ + "\nDatatable type utility functions." + ], + "signature": [ { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "docId": "kibDataPluginApi", + "section": "def-common.DatatableUtilitiesService", + "text": "DatatableUtilitiesService" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.indexPatterns", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "indexPatterns", + "description": [ + "\nindex patterns service\n{@link DataViewsContract}" + ], + "signature": [ + "DataViewsServicePublic" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": true, + "references": [ + { + "plugin": "discover", + "path": "src/plugins/discover/public/plugin.tsx" }, - ", skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/kibana_services.ts" }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "fileUpload", + "path": "x-pack/plugins/file_upload/public/kibana_services.ts" }, - "[]>; get: (id: string) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx" }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/editor.tsx" }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/components/log_stream/log_stream.tsx" }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/components/log_stream/log_stream.tsx" }, - ") => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/utils/logs_overview_fetchers.ts" }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts" }, - " | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/page_providers.tsx" }, - ", options?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/plugin.ts" }, - " | undefined) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" }, - "[]>; refreshFields: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" }, - ") => Promise; fieldArrayToMap: (fields: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts" }, - "[], fieldAttrs?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - "; createAndSave: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; createSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; updateSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getCanSaveSync: () => boolean; }" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.datatableUtilities", - "type": "Object", - "tags": [], - "label": "datatableUtilities", - "description": [ - "\nDatatable type utility functions." - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.DatatableUtilitiesService", - "text": "DatatableUtilitiesService" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.indexPatterns", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "indexPatterns", - "description": [ - "\nindex patterns service\n{@link DataViewsContract}" - ], - "signature": [ - "{ create: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>; get: (id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; refreshFields: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ") => Promise; fieldArrayToMap: (fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - "; createAndSave: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; createSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; updateSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getCanSaveSync: () => boolean; }" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "discover", - "path": "src/plugins/discover/public/build_services.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/plugin.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/plugin.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/plugin.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/plugin.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/plugin.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/kibana_services.ts" - }, - { - "plugin": "fileUpload", - "path": "x-pack/plugins/file_upload/public/kibana_services.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/file_data_visualizer/file_data_visualizer.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/editor.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/utils/logs_overview_fetchers.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/page_providers.tsx" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/plugin.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" }, { "plugin": "stackAlerts", @@ -16344,34 +15715,6 @@ "plugin": "stackAlerts", "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_details/step_details_form.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/use_search_items.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/transform_management/components/action_clone/use_clone_action.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/transform_management/components/action_discover/use_action_discover.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/transform_management/components/edit_transform_flyout/edit_transform_flyout_form.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/transform_management/components/action_edit/use_edit_action.tsx" - }, { "plugin": "uptime", "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" @@ -16388,66 +15731,6 @@ "plugin": "inputControlVis", "path": "src/plugins/input_control_vis/public/components/editor/controls_tab.tsx" }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/query_bar_wrapper.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotation_row.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/timeseries_visualization.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/search_api.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/search_api.test.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/search_api.test.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/search_api.test.ts" - }, { "plugin": "infra", "path": "x-pack/plugins/infra/public/utils/logs_overview_fetches.test.ts" @@ -16463,10 +15746,6 @@ { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_view/vega_map_view/view.test.ts" } ] }, @@ -16558,6 +15837,18 @@ "plugin": "visTypeVislib", "path": "src/plugins/vis_types/vislib/public/plugin.ts" }, + { + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, { "plugin": "expressionPartitionVis", "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" @@ -18538,158 +17829,50 @@ "signature": [ { "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, + " extends ", { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/index.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts" }, { "plugin": "ux", @@ -18700,60 +17883,28 @@ "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { "plugin": "ux", @@ -18775,10 +17926,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/types.ts" @@ -18812,344 +17959,324 @@ "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/types/app_state.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/types/app_state.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/types/app_state.ts" + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/types/app_state.ts" + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + "path": "x-pack/plugins/graph/public/state_management/mocks.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + "path": "x-pack/plugins/graph/public/state_management/mocks.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/mocks.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/mocks.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { "plugin": "visDefaultEditor", @@ -19204,92 +18331,64 @@ "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "dataViews", @@ -19345,76 +18444,32 @@ "path": "src/plugins/data_views/common/index.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "dataViews", @@ -19608,6 +18663,122 @@ "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" + }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" @@ -19620,6 +18791,98 @@ "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" + }, { "plugin": "visDefaultEditor", "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" @@ -19689,68 +18952,44 @@ "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" }, { "plugin": "dataViews", @@ -20137,54 +19376,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" @@ -20193,69 +19384,9 @@ "plugin": "maps", "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" - }, { "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" } ], "children": [], @@ -20294,54 +19425,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" @@ -20350,69 +19433,9 @@ "plugin": "maps", "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" - }, { "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" } ], "children": [], @@ -20889,127 +19912,39 @@ }, { "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/index.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts" }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts" }, { "plugin": "dataViews", @@ -21516,6 +20451,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-server.DEFAULT_QUERY_LANGUAGE", + "type": "string", + "tags": [], + "label": "DEFAULT_QUERY_LANGUAGE", + "description": [], + "signature": [ + "\"kuery\"" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-server.ES_SEARCH_STRATEGY", @@ -21571,6 +20520,14 @@ "deprecated": true, "removeBy": "8.1", "references": [ + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" @@ -21688,12 +20645,12 @@ "path": "src/plugins/discover/public/application/context/services/context_state.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" }, { "plugin": "maps", @@ -21705,11 +20662,39 @@ }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" } ], "initialIsOpen": false @@ -21764,14 +20749,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/lib/es_service.ts" @@ -21783,34 +20760,6 @@ { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_app.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_app.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" } ], "initialIsOpen": false @@ -21848,18 +20797,6 @@ "deprecated": true, "removeBy": "8.1", "references": [ - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" @@ -21899,6 +20836,14 @@ { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/target/types/server/search/session/types.d.ts" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/target/types/server/search/session/types.d.ts" } ], "initialIsOpen": false @@ -23796,6 +22741,50 @@ ], "returnComment": [] }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getTotalCount", + "type": "Function", + "tags": [], + "label": "getTotalCount", + "description": [], + "signature": [ + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => number | undefined" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getTotalCount.$1", + "type": "Object", + "tags": [], + "label": "table", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", "id": "def-common.DatatableUtilitiesService.isFilterable", @@ -26111,18 +25100,6 @@ { "plugin": "dataViews", "path": "src/plugins/data_views/common/data_views/data_views.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/plugin.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/load_saved_dashboard_state.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/plugin.ts" } ], "returnComment": [], @@ -27272,189 +26249,81 @@ "deprecated": false, "children": [ { - "parentPluginId": "data", - "id": "def-common.DuplicateDataViewError.Unnamed.$1", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.IndexPattern", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, + "parentPluginId": "data", + "id": "def-common.DuplicateDataViewError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.IndexPattern", + "type": "Class", + "tags": [ + "deprecated" + ], + "label": "IndexPattern", + "description": [], + "signature": [ { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, + " extends ", { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/index.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts" }, { "plugin": "ux", @@ -27465,60 +26334,28 @@ "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { "plugin": "ux", @@ -27540,10 +26377,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/types.ts" @@ -27577,344 +26410,324 @@ "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/types/app_state.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/types/app_state.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/types/app_state.ts" + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/types/app_state.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + "path": "x-pack/plugins/graph/public/state_management/mocks.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + "path": "x-pack/plugins/graph/public/state_management/mocks.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/mocks.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/mocks.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { "plugin": "visDefaultEditor", @@ -27969,92 +26782,64 @@ "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "dataViews", @@ -28110,280 +26895,444 @@ "path": "src/plugins/data_views/common/index.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/public/index.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/shared_imports.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" }, { "plugin": "visDefaultEditor", @@ -28470,52 +27419,28 @@ "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" }, { "plugin": "dataViews", @@ -28594,54 +27519,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" @@ -28650,69 +27527,9 @@ "plugin": "maps", "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" - }, { "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" } ], "children": [], @@ -32608,104 +31425,16 @@ "path": "src/plugins/data_views/common/data_views/data_view.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts" }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts" }, { "plugin": "dataViews", @@ -33068,64 +31797,20 @@ "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/services/es_index_service.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/services/es_index_service.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/server/routes/api/transforms.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/alerts/components/param_details_form/use_derived_index_pattern.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/server/routes/api/transforms.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/alerts/components/param_details_form/use_derived_index_pattern.d.ts" } ], "children": [ @@ -35116,6 +33801,14 @@ "deprecated": true, "removeBy": "8.1", "references": [ + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" @@ -35233,12 +33926,12 @@ "path": "src/plugins/discover/public/application/context/services/context_state.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" }, { "plugin": "maps", @@ -35250,11 +33943,39 @@ }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts" + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/context/services/context.d.ts" } ], "initialIsOpen": false @@ -35337,42 +34058,6 @@ { "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" } ], "initialIsOpen": false @@ -35402,14 +34087,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/lib/es_service.ts" @@ -35421,34 +34098,6 @@ { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_app.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_app.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" } ], "initialIsOpen": false @@ -35715,38 +34364,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable_factory.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable_factory.ts" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" @@ -35763,65 +34380,29 @@ "plugin": "graph", "path": "x-pack/plugins/graph/public/application.tsx" }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/plugin_services.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/plugin_services.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" } ], "initialIsOpen": false @@ -35853,18 +34434,6 @@ "deprecated": true, "removeBy": "8.1", "references": [ - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" @@ -35904,6 +34473,14 @@ { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/target/types/server/search/session/types.d.ts" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/target/types/server/search/session/types.d.ts" } ], "initialIsOpen": false @@ -36190,29 +34767,10 @@ }, { "parentPluginId": "data", - "id": "def-common.FILTERS", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "FILTERS", - "description": [], - "signature": [ - "typeof ", - "FILTERS" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FLEET_ASSETS_TO_IGNORE", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE", "type": "Object", "tags": [], - "label": "FLEET_ASSETS_TO_IGNORE", + "label": "DEFAULT_ASSETS_TO_IGNORE", "description": [ "\nUsed to determine if the instance has any user created index patterns by filtering index patterns\nthat are created and backed only by Fleet server data\nShould be revised after https://github.com/elastic/kibana/issues/82851 is fixed\nFor more background see: https://github.com/elastic/kibana/issues/107020" ], @@ -36221,7 +34779,7 @@ "children": [ { "parentPluginId": "data", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.LOGS_INDEX_PATTERN", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.LOGS_INDEX_PATTERN", "type": "string", "tags": [], "label": "LOGS_INDEX_PATTERN", @@ -36231,7 +34789,7 @@ }, { "parentPluginId": "data", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.METRICS_INDEX_PATTERN", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.METRICS_INDEX_PATTERN", "type": "string", "tags": [], "label": "METRICS_INDEX_PATTERN", @@ -36241,7 +34799,7 @@ }, { "parentPluginId": "data", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.LOGS_DATA_STREAM_TO_IGNORE", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.LOGS_DATA_STREAM_TO_IGNORE", "type": "string", "tags": [], "label": "LOGS_DATA_STREAM_TO_IGNORE", @@ -36251,7 +34809,7 @@ }, { "parentPluginId": "data", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.METRICS_DATA_STREAM_TO_IGNORE", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.METRICS_DATA_STREAM_TO_IGNORE", "type": "string", "tags": [], "label": "METRICS_DATA_STREAM_TO_IGNORE", @@ -36261,7 +34819,17 @@ }, { "parentPluginId": "data", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.METRICS_ENDPOINT_INDEX_TO_IGNORE", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.ENT_SEARCH_LOGS_DATA_STREAM_TO_IGNORE", + "type": "string", + "tags": [], + "label": "ENT_SEARCH_LOGS_DATA_STREAM_TO_IGNORE", + "description": [], + "path": "src/plugins/data_views/common/constants.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.METRICS_ENDPOINT_INDEX_TO_IGNORE", "type": "string", "tags": [], "label": "METRICS_ENDPOINT_INDEX_TO_IGNORE", @@ -36272,6 +34840,25 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.FILTERS", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "FILTERS", + "description": [], + "signature": [ + "typeof ", + "FILTERS" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.nodeBuilder", @@ -36300,38 +34887,6 @@ "deprecated": true, "removeBy": "8.1", "references": [ - { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts" - }, - { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts" - }, - { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts" - }, - { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts" - }, - { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" - }, { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 2a2fb979ea9770..9e7b7f168c494e 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 3419 | 40 | 2822 | 27 | +| 3457 | 40 | 2844 | 27 | ## Client diff --git a/api_docs/data_autocomplete.mdx b/api_docs/data_autocomplete.mdx index 106298ac6e007f..95abf32f9f3160 100644 --- a/api_docs/data_autocomplete.mdx +++ b/api_docs/data_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-autocomplete title: "data.autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.autocomplete plugin -date: 2022-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.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 [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3419 | 40 | 2822 | 27 | +| 3457 | 40 | 2844 | 27 | ## Client diff --git a/api_docs/data_enhanced.mdx b/api_docs/data_enhanced.mdx index f3c765e56615e8..e6bb1d274c2015 100644 --- a/api_docs/data_enhanced.mdx +++ b/api_docs/data_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataEnhanced title: "dataEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataEnhanced plugin -date: 2022-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataEnhanced'] warning: This document is auto-generated and 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_query.mdx b/api_docs/data_query.mdx index 648704c4de102d..6f33e6164e9dfc 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 3419 | 40 | 2822 | 27 | +| 3457 | 40 | 2844 | 27 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index cad0364fb7a379..eda3eb1958e371 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -16428,6 +16428,62 @@ "description": [], "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsCardinality.emptyAsNull", + "type": "CompoundType", + "tags": [], + "label": "emptyAsNull", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsCount", + "type": "Interface", + "tags": [], + "label": "AggParamsCount", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsCount", + "text": "AggParamsCount" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseAggParams", + "text": "BaseAggParams" + } + ], + "path": "src/plugins/data/common/search/aggs/metrics/count.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggParamsCount.emptyAsNull", + "type": "CompoundType", + "tags": [], + "label": "emptyAsNull", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/metrics/count.ts", + "deprecated": false } ], "initialIsOpen": false @@ -16707,6 +16763,19 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsDateHistogram.extendToTimeRange", + "type": "CompoundType", + "tags": [], + "label": "extendToTimeRange", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "deprecated": false } ], "initialIsOpen": false @@ -17503,6 +17572,19 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsHistogram.autoExtendBounds", + "type": "CompoundType", + "tags": [], + "label": "autoExtendBounds", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "deprecated": false } ], "initialIsOpen": false @@ -18591,6 +18673,19 @@ "description": [], "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsSum.emptyAsNull", + "type": "CompoundType", + "tags": [], + "label": "emptyAsNull", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", + "deprecated": false } ], "initialIsOpen": false @@ -27725,6 +27820,90 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.SQL_SEARCH_STRATEGY", + "type": "string", + "tags": [], + "label": "SQL_SEARCH_STRATEGY", + "description": [], + "signature": [ + "\"sql\"" + ], + "path": "src/plugins/data/common/search/strategies/sql_search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.SqlRequestParams", + "type": "Type", + "tags": [], + "label": "SqlRequestParams", + "description": [], + "signature": [ + "Omit<", + "SqlQueryRequest", + ", \"keep_alive\" | \"keep_on_completion\"> | Omit<", + "SqlGetAsyncRequest", + ", \"id\" | \"keep_alive\" | \"keep_on_completion\">" + ], + "path": "src/plugins/data/common/search/strategies/sql_search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.SqlSearchStrategyRequest", + "type": "Type", + "tags": [], + "label": "SqlSearchStrategyRequest", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SqlRequestParams", + "text": "SqlRequestParams" + }, + ">" + ], + "path": "src/plugins/data/common/search/strategies/sql_search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.SqlSearchStrategyResponse", + "type": "Type", + "tags": [], + "label": "SqlSearchStrategyResponse", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SqlQueryResponse", + ">" + ], + "path": "src/plugins/data/common/search/strategies/sql_search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.termsAggFilter", @@ -28229,7 +28408,7 @@ "section": "def-common.EqlRawResponse", "text": "EqlRawResponse" }, - ") => { type: string; meta: { type: string; source: string; }; columns: { id: string; name: string; meta: { type: \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"; field: string; params: {}; }; }[]; rows: any[]; }" + ") => { type: string; meta: { type: string; source: string; statistics: { totalCount: number; }; }; columns: { id: string; name: string; meta: { type: \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"; field: string; params: {}; }; }[]; rows: any[]; }" ], "path": "src/plugins/data/common/search/expressions/eql_raw_response.ts", "deprecated": false, @@ -28311,7 +28490,7 @@ "section": "def-common.EsRawResponse", "text": "EsRawResponse" }, - ") => { type: string; meta: { type: string; source: string; }; columns: { id: string; name: string; meta: { type: \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"; field: string; params: {}; }; }[]; rows: any[]; }" + ") => { type: string; meta: { type: string; source: string; statistics: { totalCount: number | undefined; }; }; columns: { id: string; name: string; meta: { type: \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"; field: string; params: {}; }; }[]; rows: any[]; }" ], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false, diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index f6731389e145b4..f6162ff2019ebf 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 3419 | 40 | 2822 | 27 | +| 3457 | 40 | 2844 | 27 | ## Client diff --git a/api_docs/data_ui.mdx b/api_docs/data_ui.mdx index 46922417897bad..c0ba389b9048cb 100644 --- a/api_docs/data_ui.mdx +++ b/api_docs/data_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-ui title: "data.ui" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.ui plugin -date: 2022-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.ui'] warning: This 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 | |-------------------|-----------|------------------------|-----------------| -| 3419 | 40 | 2822 | 27 | +| 3457 | 40 | 2844 | 27 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 61c45effd93137..00c3b7b34f0eae 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-03-15 +date: 2022-03-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 de03fc0bd21f71..3225daacfdec24 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-03-15 +date: 2022-03-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 2f68bdac8c32aa..a1bab5c7ddf82b 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-03-15 +date: 2022-03-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 1b452f280ef625..0eec355af55665 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -2223,6 +2223,59 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSavedObjectConflictError", + "type": "Class", + "tags": [], + "label": "DataViewSavedObjectConflictError", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSavedObjectConflictError", + "text": "DataViewSavedObjectConflictError" + }, + " extends Error" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSavedObjectConflictError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSavedObjectConflictError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "savedObjectId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "dataViews", "id": "def-public.DataViewsPublicPlugin", @@ -2255,13 +2308,7 @@ "text": "DataViewsPublicPluginSetup" }, ", ", - { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.DataViewsPublicPluginStart", - "text": "DataViewsPublicPluginStart" - }, + "DataViewsServicePublic", ", ", "DataViewsPublicSetupDependencies", ", ", @@ -2290,13 +2337,7 @@ "<", "DataViewsPublicStartDependencies", ", ", - { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.DataViewsPublicPluginStart", - "text": "DataViewsPublicPluginStart" - }, + "DataViewsServicePublic", ">, { expressions }: ", "DataViewsPublicSetupDependencies", ") => ", @@ -2329,13 +2370,7 @@ "<", "DataViewsPublicStartDependencies", ", ", - { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.DataViewsPublicPluginStart", - "text": "DataViewsPublicPluginStart" - }, + "DataViewsServicePublic", ">" ], "path": "src/plugins/data_views/public/plugin.ts", @@ -2378,13 +2413,7 @@ ", { fieldFormats }: ", "DataViewsPublicStartDependencies", ") => ", - { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.DataViewsPublicPluginStart", - "text": "DataViewsPublicPluginStart" - } + "DataViewsServicePublic" ], "path": "src/plugins/data_views/public/plugin.ts", "deprecated": false, @@ -2483,20 +2512,7 @@ ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": true, - "references": [ - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/plugin.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/load_saved_dashboard_state.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/plugin.ts" - } - ], + "references": [], "returnComment": [], "children": [] }, @@ -3639,6 +3655,30 @@ "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": true, "references": [ + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts" + }, { "plugin": "data", "path": "src/plugins/data/common/index.ts" @@ -3763,138 +3803,6 @@ "plugin": "data", "path": "src/plugins/data/server/index.ts" }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" - }, { "plugin": "ux", "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" @@ -3904,60 +3812,28 @@ "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { "plugin": "data", @@ -4220,8 +4096,8 @@ "path": "src/plugins/data/public/index.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" + "plugin": "data", + "path": "src/plugins/data/target/types/common/search/aggs/agg_config.d.ts" }, { "plugin": "data", @@ -4276,344 +4152,324 @@ "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/types/app_state.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/types/app_state.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/search_bar.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/types/app_state.ts" + "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/types/app_state.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + "path": "x-pack/plugins/graph/public/state_management/mocks.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + "path": "x-pack/plugins/graph/public/state_management/mocks.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/search_bar.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/inspect_panel.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/components/workspace_layout/workspace_layout.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/mocks.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/mocks.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { "plugin": "visDefaultEditor", @@ -4668,92 +4524,64 @@ "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" } ], "children": [], @@ -4833,76 +4661,32 @@ "path": "src/plugins/data/server/index.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "data", @@ -5154,316 +4938,331 @@ }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.IndexPatternsService", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsService", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" }, - " extends ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" + }, { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" }, { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" } ], "children": [], @@ -5471,54 +5270,115 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon", + "id": "def-public.IndexPatternsService", "type": "Class", - "tags": [], - "label": "SavedObjectsClientPublicToCommon", + "tags": [ + "deprecated" + ], + "label": "IndexPatternsService", "description": [], "signature": [ { "pluginId": "dataViews", - "scope": "public", + "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-public.SavedObjectsClientPublicToCommon", - "text": "SavedObjectsClientPublicToCommon" + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" }, - " implements ", + " extends ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommon", - "text": "SavedObjectsClientCommon" + "section": "def-common.DataViewsService", + "text": "DataViewsService" } ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": true, + "references": [ { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "savedObjectClient", - "description": [], - "signature": [ - "SOClient" - ], + "plugin": "data", + "path": "src/plugins/data/common/index.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/server/index.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/server/index.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/server/index.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/public/index.ts" + } + ], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon", + "type": "Class", + "tags": [], + "label": "SavedObjectsClientPublicToCommon", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.SavedObjectsClientPublicToCommon", + "text": "SavedObjectsClientPublicToCommon" + }, + " implements ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommon", + "text": "SavedObjectsClientCommon" + } + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "savedObjectClient", + "description": [], + "signature": [ + "SOClient" + ], "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", "deprecated": false, "isRequired": true @@ -5990,6 +5850,74 @@ } ], "functions": [ + { + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeMulti", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeMulti", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeMulti.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeNested", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeNested", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeNested", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeNested.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "dataViews", "id": "def-public.onRedirectNoIndexPattern", @@ -6142,50 +6070,39 @@ "interfaces": [ { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem", + "id": "def-public.DataViewAttributes", "type": "Interface", "tags": [], - "label": "DataViewListItem", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "label": "DataViewAttributes", + "description": [ + "\nInterface for an index pattern saved object" + ], + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.id", + "id": "def-public.DataViewAttributes.fields", "type": "string", "tags": [], - "label": "id", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", + "label": "fields", "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.title", + "id": "def-public.DataViewAttributes.title", "type": "string", "tags": [], "label": "title", "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.type", + "id": "def-public.DataViewAttributes.type", "type": "string", "tags": [], "label": "type", @@ -6193,53 +6110,29 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.typeMeta", - "type": "Object", + "id": "def-public.DataViewAttributes.typeMeta", + "type": "string", "tags": [], "label": "typeMeta", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" - }, - " | undefined" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec", - "type": "Interface", - "tags": [], - "label": "DataViewSpec", - "description": [ - "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.id", + "id": "def-public.DataViewAttributes.timeFieldName", "type": "string", "tags": [], - "label": "id", - "description": [ - "\nsaved object id" - ], + "label": "timeFieldName", + "description": [], "signature": [ "string | undefined" ], @@ -6248,13 +6141,11 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.version", + "id": "def-public.DataViewAttributes.sourceFilters", "type": "string", "tags": [], - "label": "version", - "description": [ - "\nsaved object version string" - ], + "label": "sourceFilters", + "description": [], "signature": [ "string | undefined" ], @@ -6263,10 +6154,10 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.title", + "id": "def-public.DataViewAttributes.fieldFormatMap", "type": "string", "tags": [], - "label": "title", + "label": "fieldFormatMap", "description": [], "signature": [ "string | undefined" @@ -6276,10 +6167,10 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.timeFieldName", + "id": "def-public.DataViewAttributes.fieldAttrs", "type": "string", "tags": [], - "label": "timeFieldName", + "label": "fieldAttrs", "description": [], "signature": [ "string | undefined" @@ -6289,36 +6180,214 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.sourceFilters", - "type": "Array", + "id": "def-public.DataViewAttributes.runtimeFieldMap", + "type": "string", "tags": [], - "label": "sourceFilters", + "label": "runtimeFieldMap", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" - }, - "[] | undefined" + "string | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.fields", - "type": "Object", + "id": "def-public.DataViewAttributes.allowNoIndex", + "type": "CompoundType", "tags": [], - "label": "fields", - "description": [], + "label": "allowNoIndex", + "description": [ + "\nprevents errors when index pattern exists before indices" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem", + "type": "Interface", + "tags": [], + "label": "DataViewListItem", + "description": [], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.typeMeta", + "type": "Object", + "tags": [], + "label": "typeMeta", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec", + "type": "Interface", + "tags": [], + "label": "DataViewSpec", + "description": [ + "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nsaved object id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nsaved object version string" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.sourceFilters", + "type": "Array", + "tags": [], + "label": "sourceFilters", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.fields", + "type": "Object", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewFieldMap", "text": "DataViewFieldMap" }, @@ -6461,59 +6530,290 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList", + "id": "def-public.FieldSpec", "type": "Interface", "tags": [], - "label": "IIndexPatternFieldList", + "label": "FieldSpec", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" + "DataViewFieldBase" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.add", - "type": "Function", + "id": "def-public.FieldSpec.count", + "type": "number", "tags": [], - "label": "add", + "label": "count", + "description": [ + "\nPopularity count is used by discover" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.format", + "type": "Object", + "tags": [], + "label": "format", "description": [], "signature": [ - "(field: ", { - "pluginId": "dataViews", + "pluginId": "fieldFormats", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, - ") => ", + "<", { - "pluginId": "dataViews", + "pluginId": "fieldFormats", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + "> | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.readFromDocValues", + "type": "CompoundType", + "tags": [], + "label": "readFromDocValues", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.indexed", + "type": "CompoundType", + "tags": [], + "label": "indexed", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.runtimeField", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.shortDotsEnable", + "type": "CompoundType", + "tags": [], + "label": "shortDotsEnable", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.isMapped", + "type": "CompoundType", + "tags": [], + "label": "isMapped", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.HasDataViewsResponse", + "type": "Interface", + "tags": [], + "label": "HasDataViewsResponse", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.HasDataViewsResponse.hasDataView", + "type": "boolean", + "tags": [], + "label": "hasDataView", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.HasDataViewsResponse.hasUserDataView", + "type": "boolean", + "tags": [], + "label": "hasUserDataView", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.IIndexPatternFieldList", + "type": "Interface", + "tags": [], + "label": "IIndexPatternFieldList", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.IIndexPatternFieldList.add", + "type": "Function", + "tags": [], + "label": "add", + "description": [], + "signature": [ + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, "children": [ { "parentPluginId": "dataViews", @@ -6902,69 +7202,162 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.TypeMeta", + "id": "def-public.IndicesResponse", "type": "Interface", "tags": [], - "label": "TypeMeta", + "label": "IndicesResponse", "description": [], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/public/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.TypeMeta.aggs", - "type": "Object", + "id": "def-public.IndicesResponse.indices", + "type": "Array", "tags": [], - "label": "aggs", + "label": "indices", "description": [], "signature": [ - "Record | undefined" + "IndicesResponseItemIndex", + "[] | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/public/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.TypeMeta.params", - "type": "Object", + "id": "def-public.IndicesResponse.aliases", + "type": "Array", "tags": [], - "label": "params", + "label": "aliases", "description": [], "signature": [ - "{ rollup_index: string; } | undefined" + "IndicesResponseItemAlias", + "[] | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.IndicesResponse.data_streams", + "type": "Array", + "tags": [], + "label": "data_streams", + "description": [], + "signature": [ + "IndicesResponseItemDataStream", + "[] | undefined" + ], + "path": "src/plugins/data_views/public/types.ts", "deprecated": false } ], "initialIsOpen": false - } - ], - "enums": [ + }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewType", - "type": "Enum", + "id": "def-public.IndicesResponseModified", + "type": "Interface", "tags": [], - "label": "DataViewType", + "label": "IndicesResponseModified", "description": [], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/public/types.ts", "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "dataViews", - "id": "def-public.CONTAINS_SPACES_KEY", + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.IndicesResponseModified.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.IndicesResponseModified.item", + "type": "Object", + "tags": [], + "label": "item", + "description": [], + "signature": [ + "{ name: string; backing_indices?: string[] | undefined; timestamp_field?: string | undefined; indices?: string[] | undefined; aliases?: string[] | undefined; attributes?: ", + "IndicesResponseItemIndexAttrs", + "[] | undefined; data_stream?: string | undefined; }" + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.TypeMeta", + "type": "Interface", + "tags": [], + "label": "TypeMeta", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.TypeMeta.aggs", + "type": "Object", + "tags": [], + "label": "aggs", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.TypeMeta.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ rollup_index: string; } | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewType", + "type": "Enum", + "tags": [], + "label": "DataViewType", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "dataViews", + "id": "def-public.CONTAINS_SPACES_KEY", "type": "string", "tags": [], "label": "CONTAINS_SPACES_KEY", @@ -6992,10 +7385,54 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewsContract", - "type": "Type", + "id": "def-public.ILLEGAL_CHARACTERS", + "type": "Array", "tags": [], - "label": "DataViewsContract", + "label": "ILLEGAL_CHARACTERS", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/lib/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.ILLEGAL_CHARACTERS_KEY", + "type": "string", + "tags": [], + "label": "ILLEGAL_CHARACTERS_KEY", + "description": [], + "signature": [ + "\"ILLEGAL_CHARACTERS\"" + ], + "path": "src/plugins/data_views/common/lib/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.ILLEGAL_CHARACTERS_VISIBLE", + "type": "Array", + "tags": [], + "label": "ILLEGAL_CHARACTERS_VISIBLE", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/lib/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.IndexPatternsContract", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "IndexPatternsContract", "description": [], "signature": [ "{ create: (spec: ", @@ -7198,292 +7635,34 @@ "section": "def-common.DataView", "text": "DataView" }, - " | null>; getCanSaveSync: () => boolean; }" - ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.ILLEGAL_CHARACTERS", - "type": "Array", - "tags": [], - "label": "ILLEGAL_CHARACTERS", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/lib/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.ILLEGAL_CHARACTERS_KEY", - "type": "string", - "tags": [], - "label": "ILLEGAL_CHARACTERS_KEY", - "description": [], - "signature": [ - "\"ILLEGAL_CHARACTERS\"" - ], - "path": "src/plugins/data_views/common/lib/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.ILLEGAL_CHARACTERS_VISIBLE", - "type": "Array", - "tags": [], - "label": "ILLEGAL_CHARACTERS_VISIBLE", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/lib/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.IndexPatternsContract", - "type": "Type", - "tags": [ - "deprecated" + " | null>; }" ], - "label": "IndexPatternsContract", - "description": [], - "signature": [ - "{ create: (spec: ", + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": true, + "references": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "data", + "path": "src/plugins/data/common/index.ts" }, - ", skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/create_search_source.ts" }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/create_search_source.ts" }, - "[]>; get: (id: string) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source_service.ts" }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source_service.ts" }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; refreshFields: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ") => Promise; fieldArrayToMap: (fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - "; createAndSave: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; createSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; updateSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; }" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts" + "plugin": "data", + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts" }, { "plugin": "data", @@ -7585,38 +7764,6 @@ "plugin": "data", "path": "src/plugins/data/public/search/search_service.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable_factory.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable_factory.ts" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" @@ -7633,57 +7780,29 @@ "plugin": "graph", "path": "x-pack/plugins/graph/public/application.tsx" }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/plugin_services.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/plugin_services.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { "plugin": "data", @@ -7702,12 +7821,20 @@ "path": "src/plugins/data/public/actions/filters/create_filters_from_value_click.test.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts" + "plugin": "data", + "path": "src/plugins/data/target/types/public/ui/index_pattern_select/index_pattern_select.d.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/target/types/public/ui/index_pattern_select/index_pattern_select.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts" + "plugin": "data", + "path": "src/plugins/data/target/types/public/ui/index_pattern_select/create_index_pattern_select.d.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/target/types/public/ui/index_pattern_select/create_index_pattern_select.d.ts" } ], "initialIsOpen": false @@ -7759,215 +7886,13 @@ }, "start": { "parentPluginId": "dataViews", - "id": "def-public.DataViewsPublicPluginStart", + "id": "def-public.DataViewsContract", "type": "Type", "tags": [], - "label": "DataViewsPublicPluginStart", - "description": [ - "\nData views plugin public Start contract" - ], + "label": "DataViewsContract", + "description": [], "signature": [ - "{ create: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>; get: (id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; refreshFields: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ") => Promise; fieldArrayToMap: (fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - "; createAndSave: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; createSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; updateSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getCanSaveSync: () => boolean; }" + "DataViewsServicePublic" ], "path": "src/plugins/data_views/public/types.ts", "deprecated": false, @@ -11077,14 +11002,6 @@ "plugin": "data", "path": "src/plugins/data/server/search/search_service.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - }, { "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" @@ -11104,10 +11021,6 @@ { "plugin": "maps", "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/server/routes/run.ts" } ], "returnComment": [], @@ -14902,20 +14815,7 @@ ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": true, - "references": [ - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/plugin.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/load_saved_dashboard_state.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/plugin.ts" - } - ], + "references": [], "returnComment": [], "children": [] }, @@ -16111,6 +16011,30 @@ "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": true, "references": [ + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts" + }, { "plugin": "data", "path": "src/plugins/data/common/index.ts" @@ -16235,138 +16159,6 @@ "plugin": "data", "path": "src/plugins/data/server/index.ts" }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_pattern_management/index_pattern_management.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/actions.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/types/index.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/common/types/index_pattern.ts" - }, { "plugin": "ux", "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" @@ -16376,60 +16168,28 @@ "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/existing_fields.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" }, { "plugin": "data", @@ -16692,8 +16452,8 @@ "path": "src/plugins/data/public/index.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" + "plugin": "data", + "path": "src/plugins/data/target/types/common/search/aggs/agg_config.d.ts" }, { "plugin": "data", @@ -16747,110 +16507,6 @@ "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/vis_types/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts" - }, { "plugin": "graph", "path": "x-pack/plugins/graph/public/types/app_state.ts" @@ -16940,132 +16596,132 @@ "path": "x-pack/plugins/graph/public/services/index_pattern_cache.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/mocks.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/mocks.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/common/request.ts" + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/mocks.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/mocks.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/es_search_source.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "path": "x-pack/plugins/maps/target/types/public/components/geo_index_pattern_select.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { "plugin": "maps", @@ -17073,19 +16729,103 @@ }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/count_agg_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/agg/agg_field.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/geo_line_form.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/filter_editor/filter_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/where_expression.d.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { "plugin": "visDefaultEditor", @@ -17140,92 +16880,64 @@ "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/panel_config/types.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/annotations_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "dataViewFieldEditor", + "path": "src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/utils/editor_config.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.ts" + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" }, { "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/metrics_type.test.ts" + "path": "src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts" } ], "children": [], @@ -17305,76 +17017,32 @@ "path": "src/plugins/data/server/index.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/server/routes/field_stats.ts" + "path": "x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts" }, { "plugin": "data", @@ -17626,316 +17294,392 @@ }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/fields/es_doc_field.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/update_source_editor.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/geo_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metrics_editor.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IndexPatternsService", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsService", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/components/metrics_editor/metric_editor.d.ts" }, - " extends ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" + }, { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_geo_line_source/update_source_editor.d.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/layers/wizards/choropleth_layer_wizard/layer_template.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/create_source_editor.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/classes/sources/es_search_source/top_hits/top_hits_form.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/types.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" }, { "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "path": "x-pack/plugins/maps/target/types/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.d.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/fields_fetcher.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.test.ts" + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/agg_param_props.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/target/types/public/components/controls/top_sort_field.d.ts" + } + ], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.IndexPatternsService", + "type": "Class", + "tags": [ + "deprecated" + ], + "label": "IndexPatternsService", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsService", + "text": "DataViewsService" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": true, + "references": [ + { + "plugin": "data", + "path": "src/plugins/data/common/index.ts" }, { "plugin": "data", - "path": "src/plugins/data/public/index.ts" + "path": "src/plugins/data/server/index.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" + "plugin": "data", + "path": "src/plugins/data/server/index.ts" }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx" + "plugin": "data", + "path": "src/plugins/data/server/index.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/public/index.ts" } ], "children": [], @@ -18576,99 +18320,1143 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.fieldFormats", - "type": "Object", + "id": "def-common.DataViewSpec.fieldFormats", + "type": "Object", + "tags": [], + "label": "fieldFormats", + "description": [], + "signature": [ + "Record> | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec.runtimeFieldMap", + "type": "Object", + "tags": [], + "label": "runtimeFieldMap", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec.fieldAttrs", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec.allowNoIndex", + "type": "CompoundType", + "tags": [], + "label": "allowNoIndex", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods", + "type": "Interface", + "tags": [], + "label": "DataViewsServicePublicMethods", + "description": [], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.clearCache", + "type": "Function", + "tags": [], + "label": "clearCache", + "description": [], + "signature": [ + "(id?: string | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.clearCache.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", skipFetchFields?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.create.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.create.$2", + "type": "CompoundType", + "tags": [], + "label": "skipFetchFields", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createAndSave", + "type": "Function", + "tags": [], + "label": "createAndSave", + "description": [], + "signature": [ + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", override?: boolean | undefined, skipFetchFields?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createAndSave.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createAndSave.$2", + "type": "CompoundType", + "tags": [], + "label": "override", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createAndSave.$3", + "type": "CompoundType", + "tags": [], + "label": "skipFetchFields", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createSavedObject", + "type": "Function", + "tags": [], + "label": "createSavedObject", + "description": [], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", override?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createSavedObject.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createSavedObject.$2", + "type": "CompoundType", + "tags": [], + "label": "override", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [], + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.delete.$1", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.ensureDefaultDataView", + "type": "Function", + "tags": [], + "label": "ensureDefaultDataView", + "description": [], + "signature": [ + "() => Promise | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap", + "type": "Function", + "tags": [], + "label": "fieldArrayToMap", + "description": [], + "signature": [ + "(fields: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap.$1", + "type": "Array", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap.$2", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [], + "signature": [ + "(search: string, size?: number | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.find.$1", + "type": "string", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.find.$2", + "type": "number", + "tags": [], + "label": "size", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getCache", + "type": "Function", + "tags": [], + "label": "getCache", + "description": [], + "signature": [ + "() => Promise<", + "SavedObject", + "<", + "IndexPatternSavedObjectAttrs", + ">[] | null | undefined>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getCanSave", + "type": "Function", + "tags": [], + "label": "getCanSave", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getDefault", + "type": "Function", + "tags": [], + "label": "getDefault", + "description": [], + "signature": [ + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getDefaultId", + "type": "Function", + "tags": [], + "label": "getDefaultId", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getDefaultDataView", + "type": "Function", + "tags": [], + "label": "getDefaultDataView", + "description": [], + "signature": [ + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern.$1", + "type": "CompoundType", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForWildcard", + "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getIds", + "type": "Function", + "tags": [], + "label": "getIds", + "description": [], + "signature": [ + "(refresh?: boolean | undefined) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getIds.$1", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getIdsWithTitle", + "type": "Function", + "tags": [], + "label": "getIdsWithTitle", + "description": [], + "signature": [ + "(refresh?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getIdsWithTitle.$1", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [], + "signature": [ + "(refresh?: boolean | undefined) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getTitles.$1", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.hasUserDataView", + "type": "Function", + "tags": [], + "label": "hasUserDataView", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.refreshFields", + "type": "Function", "tags": [], - "label": "fieldFormats", + "label": "refreshFields", "description": [], "signature": [ - "Record Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - ">> | undefined" + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.refreshFields.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.runtimeFieldMap", - "type": "Object", + "id": "def-common.DataViewsServicePublicMethods.savedObjectToSpec", + "type": "Function", "tags": [], - "label": "runtimeFieldMap", + "label": "savedObjectToSpec", "description": [], "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.fieldAttrs", - "type": "Object", - "tags": [], - "label": "fieldAttrs", - "description": [], - "signature": [ + ">) => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.savedObjectToSpec.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.allowNoIndex", - "type": "CompoundType", + "id": "def-common.DataViewsServicePublicMethods.setDefault", + "type": "Function", "tags": [], - "label": "allowNoIndex", + "label": "setDefault", "description": [], "signature": [ - "boolean | undefined" + "(id: string | null, force?: boolean | undefined) => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.setDefault.$1", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | null" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.setDefault.$2", + "type": "CompoundType", + "tags": [], + "label": "force", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.namespaces", - "type": "Array", + "id": "def-common.DataViewsServicePublicMethods.updateSavedObject", + "type": "Function", "tags": [], - "label": "namespaces", + "label": "updateSavedObject", "description": [], "signature": [ - "string[] | undefined" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", saveAttempts?: number | undefined, ignoreErrors?: boolean | undefined) => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$2", + "type": "number", + "tags": [], + "label": "saveAttempts", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$3", + "type": "CompoundType", + "tags": [], + "label": "ignoreErrors", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -19275,36 +20063,94 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptionsTimePattern.metaFields", - "type": "Array", + "id": "def-common.GetFieldsOptionsTimePattern.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptionsTimePattern.lookBack", + "type": "number", + "tags": [], + "label": "lookBack", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptionsTimePattern.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.HasDataService", + "type": "Interface", + "tags": [], + "label": "HasDataService", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.HasDataService.hasESData", + "type": "Function", "tags": [], - "label": "metaFields", + "label": "hasESData", "description": [], "signature": [ - "string[]" + "() => Promise" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptionsTimePattern.lookBack", - "type": "number", + "id": "def-common.HasDataService.hasUserDataView", + "type": "Function", "tags": [], - "label": "lookBack", + "label": "hasUserDataView", "description": [], + "signature": [ + "() => Promise" + ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptionsTimePattern.interval", - "type": "string", + "id": "def-common.HasDataService.hasDataView", + "type": "Function", "tags": [], - "label": "interval", + "label": "hasDataView", "description": [], + "signature": [ + "() => Promise" + ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -19587,35 +20433,11 @@ }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts" }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx" + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts" }, { "plugin": "data", @@ -19645,70 +20467,6 @@ "plugin": "data", "path": "src/plugins/data/server/index.ts" }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, { "plugin": "data", "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" @@ -20306,64 +21064,20 @@ "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/services/es_index_service.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/services/es_index_service.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/server/routes/api/transforms.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/alerts/components/param_details_form/use_derived_index_pattern.d.ts" }, { - "plugin": "transform", - "path": "x-pack/plugins/transform/server/routes/api/transforms.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/target/types/public/alerts/components/param_details_form/use_derived_index_pattern.d.ts" }, { "plugin": "data", @@ -22382,42 +23096,6 @@ { "plugin": "data", "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts" } ], "initialIsOpen": false @@ -22451,14 +23129,6 @@ "plugin": "data", "path": "src/plugins/data/public/index.ts" }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/lib/es_service.ts" @@ -22474,34 +23144,6 @@ { "plugin": "data", "path": "src/plugins/data/server/index.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_app.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_app.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/discover_main_route.tsx" } ], "initialIsOpen": false @@ -22884,38 +23526,6 @@ "plugin": "data", "path": "src/plugins/data/public/search/search_service.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/utils.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable_factory.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable_factory.ts" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" @@ -22932,57 +23542,29 @@ "plugin": "graph", "path": "x-pack/plugins/graph/public/application.tsx" }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" - }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "path": "x-pack/plugins/lens/target/types/public/utils.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/plugin_services.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/plugin_services.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts" }, { "plugin": "data", @@ -23001,12 +23583,20 @@ "path": "src/plugins/data/public/actions/filters/create_filters_from_value_click.test.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts" + "plugin": "data", + "path": "src/plugins/data/target/types/public/ui/index_pattern_select/index_pattern_select.d.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/target/types/public/ui/index_pattern_select/index_pattern_select.d.ts" }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts" + "plugin": "data", + "path": "src/plugins/data/target/types/public/ui/index_pattern_select/create_index_pattern_select.d.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/target/types/public/ui/index_pattern_select/create_index_pattern_select.d.ts" } ], "initialIsOpen": false @@ -23156,10 +23746,10 @@ "objects": [ { "parentPluginId": "dataViews", - "id": "def-common.FLEET_ASSETS_TO_IGNORE", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE", "type": "Object", "tags": [], - "label": "FLEET_ASSETS_TO_IGNORE", + "label": "DEFAULT_ASSETS_TO_IGNORE", "description": [ "\nUsed to determine if the instance has any user created index patterns by filtering index patterns\nthat are created and backed only by Fleet server data\nShould be revised after https://github.com/elastic/kibana/issues/82851 is fixed\nFor more background see: https://github.com/elastic/kibana/issues/107020" ], @@ -23168,7 +23758,7 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.LOGS_INDEX_PATTERN", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.LOGS_INDEX_PATTERN", "type": "string", "tags": [], "label": "LOGS_INDEX_PATTERN", @@ -23178,7 +23768,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.METRICS_INDEX_PATTERN", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.METRICS_INDEX_PATTERN", "type": "string", "tags": [], "label": "METRICS_INDEX_PATTERN", @@ -23188,7 +23778,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.LOGS_DATA_STREAM_TO_IGNORE", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.LOGS_DATA_STREAM_TO_IGNORE", "type": "string", "tags": [], "label": "LOGS_DATA_STREAM_TO_IGNORE", @@ -23198,7 +23788,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.METRICS_DATA_STREAM_TO_IGNORE", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.METRICS_DATA_STREAM_TO_IGNORE", "type": "string", "tags": [], "label": "METRICS_DATA_STREAM_TO_IGNORE", @@ -23208,7 +23798,17 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.FLEET_ASSETS_TO_IGNORE.METRICS_ENDPOINT_INDEX_TO_IGNORE", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.ENT_SEARCH_LOGS_DATA_STREAM_TO_IGNORE", + "type": "string", + "tags": [], + "label": "ENT_SEARCH_LOGS_DATA_STREAM_TO_IGNORE", + "description": [], + "path": "src/plugins/data_views/common/constants.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DEFAULT_ASSETS_TO_IGNORE.METRICS_ENDPOINT_INDEX_TO_IGNORE", "type": "string", "tags": [], "label": "METRICS_ENDPOINT_INDEX_TO_IGNORE", diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 02a74e15cdf551..4c71562979145b 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 765 | 3 | 616 | 10 | +| 863 | 3 | 711 | 15 | ## Client diff --git a/api_docs/data_visualizer.devdocs.json b/api_docs/data_visualizer.devdocs.json index 8bdc2a75d8605e..f1872077f3338a 100644 --- a/api_docs/data_visualizer.devdocs.json +++ b/api_docs/data_visualizer.devdocs.json @@ -16,18 +16,18 @@ "children": [ { "parentPluginId": "dataVisualizer", - "id": "def-public.IndexDataVisualizerViewProps.currentIndexPattern", + "id": "def-public.IndexDataVisualizerViewProps.currentDataView", "type": "Object", "tags": [], - "label": "currentIndexPattern", + "label": "currentDataView", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" } ], "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx", diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index f74403095f8579..0ca7eaa1ebd7a7 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-03-15 +date: 2022-03-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 4236c0599f5fdc..4443dcb6ff4b08 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-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -13,54 +13,45 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Referencing plugin(s) | Remove By | | ---------------|-----------|-----------| -| | dataViews, visTypeTimeseries, maps, data | - | -| | dataViews, lens, maps, graph, stackAlerts, transform, visTypeTimelion, data | - | -| | dataViews, visTypeTimeseries, dataVisualizer, transform, ux, lens, savedObjects, dataViewEditor, visualizations, graph, stackAlerts, uptime, maps, visDefaultEditor, visTypeVega, data | - | -| | dataViews, dataVisualizer, lens, dataViewEditor, maps, visDefaultEditor, visTypeTimeseries, discover, data | - | -| | dataViews, monitoring, stackAlerts, transform | - | -| | dataViews, transform, canvas, discover | - | -| | dataViews, monitoring, stackAlerts, transform, data | - | -| | dataViews, transform, canvas, discover, data | - | -| | dataViews, lens, maps, graph, stackAlerts, transform, visTypeTimelion, data | - | -| | dataViews, visualizations, data | - | -| | dataViews, dataVisualizer, lens, dataViewEditor, maps, visDefaultEditor, visTypeTimeseries, discover, data | - | -| | dataViews, visTypeTimeseries, maps, data | - | -| | dataViews, visualizations, dashboard, lens | - | -| | dataViews, visTypeTimeseries, dataVisualizer, transform, ux, lens, savedObjects, dataViewEditor, visualizations, graph, stackAlerts, uptime, maps, visDefaultEditor, visTypeVega, data | - | +| | dataViews, maps, data | - | +| | dataViews, maps, graph, lens, stackAlerts, data | - | +| | dataViews, upgradeAssistant, dashboard, visualizations, discover, ux, maps, savedObjects, dataViewEditor, graph, uptime, lens, stackAlerts, visDefaultEditor, dataViewFieldEditor, inputControlVis, visTypeTimeseries, data | - | +| | dataViews, maps, lens, dataViewEditor, visDefaultEditor, data | - | +| | dataViews, monitoring | - | +| | dataViews, canvas | - | +| | dataViews, monitoring, data | - | +| | dataViews, canvas, data | - | +| | dataViews, maps, graph, lens, stackAlerts, data | - | +| | dataViews, data | - | +| | dataViews, maps, lens, dataViewEditor, visDefaultEditor, data | - | +| | dataViews, maps, data | - | +| | dataViews | - | +| | dataViews, upgradeAssistant, dashboard, visualizations, discover, ux, maps, savedObjects, dataViewEditor, graph, uptime, lens, stackAlerts, visDefaultEditor, dataViewFieldEditor, inputControlVis, visTypeTimeseries, data | - | | | dataViews, maps | - | | | dataViewManagement, dataViews | - | | | visTypeTimeseries, graph, dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | -| | dataViews, transform, canvas, discover | - | -| | dataViews, dataVisualizer, lens, dataViewEditor, maps, visDefaultEditor, visTypeTimeseries, discover | - | -| | dataViews, visTypeTimeseries, dataVisualizer, transform, ux, lens, savedObjects, dataViewEditor, visualizations, graph, stackAlerts, uptime, maps, visDefaultEditor, visTypeVega | - | -| | dataViews, visTypeTimeseries, maps | - | +| | dataViews, canvas | - | +| | dataViews, maps, lens, dataViewEditor, visDefaultEditor | - | +| | dataViews, upgradeAssistant, dashboard, visualizations, discover, ux, maps, savedObjects, dataViewEditor, graph, uptime, lens, stackAlerts, visDefaultEditor, dataViewFieldEditor, inputControlVis, visTypeTimeseries | - | +| | dataViews, maps | - | | | dataViews, maps | - | | | dataViewManagement, dataViews | - | | | visTypeTimeseries, graph, dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | -| | discover, visualizations, lens, maps, fileUpload, dataVisualizer, infra, graph, monitoring, securitySolution, stackAlerts, transform, uptime, inputControlVis, visTypeTimelion, visTypeTimeseries, visTypeVega, savedObjects | - | -| | discover, dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, expressionPartitionVis | - | -| | visTypeTimeseries | - | -| | visTypeTimeseries, graph, dataViewManagement | - | -| | data, lens, visTypeTimeseries, infra, maps, visTypeTimelion | - | +| | discover, maps, fileUpload, infra, graph, monitoring, securitySolution, stackAlerts, uptime, inputControlVis, savedObjects | - | | | maps | - | +| | data, infra, maps | - | | | dashboard, maps | - | -| | visualizations, dashboard, maps, graph | - | -| | visualizations, dashboard, lens, maps, ml, securitySolution, security | - | -| | lens, dashboard, maps | - | -| | visualizations, dashboard, lens | - | -| | savedObjectsTaggingOss, visualizations, dashboard, lens | - | -| | embeddable, presentationUtil, discover, dashboard, graph | - | -| | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | - | -| | visTypeVega | - | -| | monitoring, visTypeVega | - | +| | visTypeTimeseries, graph, dataViewManagement | - | +| | discover, dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, dataViewFieldEditor, expressionPartitionVis | - | +| | esUiShared, home, spaces, fleet, visualizations, lens, observability, dataEnhanced, ml, apm, cloudSecurityPosture, indexLifecycleManagement, upgradeAssistant, uptime, ux, kibanaOverview, savedObjectsManagement | - | | | discover | - | | | discover | - | | | data, discover, embeddable | - | | | advancedSettings, discover | - | | | advancedSettings, discover | - | -| | monitoring, kibanaUsageCollection | - | +| | visTypeTimeseries | - | | | canvas, visTypeXy | - | | | canvas | - | | | canvas | - | @@ -71,48 +62,68 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | canvas | - | | | canvas | - | | | canvas, visTypeXy | - | -| | apm, security, securitySolution | - | -| | apm, security, securitySolution | - | | | encryptedSavedObjects, actions, cloud, ml, dataEnhanced, logstash, securitySolution | - | -| | securitySolution | - | -| | dashboard | - | -| | actions, alerting | - | -| | cloud, apm | - | -| | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | - | | | dataViewManagement | - | | | dataViewManagement | - | +| | spaces, savedObjectsManagement | - | +| | spaces, savedObjectsManagement | - | | | actions, ml, enterpriseSearch, savedObjectsTagging | - | | | visTypeGauge | - | | | visTypePie | - | | | visTypePie | - | -| | security, fleet | - | -| | security | - | -| | security, fleet | - | -| | security, fleet | - | -| | security | - | -| | management, fleet, security, kibanaOverview | - | -| | ml | - | -| | spaces, savedObjectsManagement | - | -| | spaces, savedObjectsManagement | - | -| | mapsEms | - | +| | actions, alerting | - | | | console | - | | | discover, maps, inputControlVis | 8.1 | | | discover, discoverEnhanced, maps | 8.1 | -| | dashboard, discoverEnhanced, urlDrilldown, discover, maps | 8.1 | -| | dashboard, discoverEnhanced, urlDrilldown, discover, maps | 8.1 | +| | discover, dashboard, discoverEnhanced, urlDrilldown, maps | 8.1 | +| | discover, dashboard, discoverEnhanced, urlDrilldown, maps | 8.1 | | | discover, maps, inputControlVis | 8.1 | -| | dashboard, discoverEnhanced, urlDrilldown, discover, maps | 8.1 | -| | apm, graph, stackAlerts | 8.1 | -| | stackAlerts | 8.1 | +| | discover, dashboard, discoverEnhanced, urlDrilldown, maps | 8.1 | +| | apm, graph | 8.1 | | | discoverEnhanced | 8.1 | | | discoverEnhanced | 8.1 | -| | alerting, dataEnhanced | 8.1 | -| | alerting, dataEnhanced | 8.1 | -| | actions, alerting, dataEnhanced | 8.1 | -| | alerting, dataEnhanced | 8.1 | +| | dataEnhanced | 8.1 | +| | dataEnhanced | 8.1 | +| | dataEnhanced | 8.1 | +| | dataEnhanced | 8.1 | | | dataViews, stackAlerts | 8.2 | | | dataViews, stackAlerts, data | 8.2 | | | dataViews, stackAlerts | 8.2 | +| | visualizations, dashboard, maps, graph | 8.8.0 | +| | visualizations, dashboard, lens, maps, ml, securitySolution, security | 8.8.0 | +| | lens, dashboard, maps | 8.8.0 | +| | embeddable, presentationUtil, discover, dashboard, graph | 8.8.0 | +| | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | +| | savedObjectsTaggingOss, visualizations, dashboard, lens | 8.8.0 | +| | dashboard | 8.8.0 | +| | monitoring, visTypeVega | 8.8.0 | +| | monitoring, kibanaUsageCollection | 8.8.0 | +| | apm, security, securitySolution | 8.8.0 | +| | apm, security, securitySolution | 8.8.0 | +| | securitySolution | 8.8.0 | +| | cloud, apm | 8.8.0 | +| | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | +| | spaces, security, alerting | 8.8.0 | +| | security, fleet | 8.8.0 | +| | security, fleet | 8.8.0 | +| | security, fleet | 8.8.0 | +| | management, fleet, security, kibanaOverview | 8.8.0 | +| | fleet | 8.8.0 | +| | security | 8.8.0 | +| | mapsEms | 8.8.0 | +| | visTypeVega | 8.8.0 | +| | ml | 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. | +| | security | 8.8.0 + +This is relied on by the reporting feature, and should be removed once reporting +migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | +| | security | 8.8.0 + +This is relied on by the reporting feature, and should be removed once reporting +migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | ## Unreferenced deprecated APIs @@ -129,63 +140,69 @@ Safe to remove. | | data | | | data | | | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | +| | data | +| | data | +| | data | +| | data | +| | data | +| | data | +| | data | | | data | -| | data | -| | data | +| | data | +| | data | +| | data | | | data | | | data | -| | data | -| | data | | | data | -| | data | +| | data | +| | data | +| | data | +| | data | | | data | -| | data | -| | data | +| | data | | | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | +| | data | +| | data | +| | data | +| | data | | | data | -| | data | +| | data | +| | data | +| | data | +| | data | +| | data | +| | data | | | data | +| | data | +| | data | +| | data | +| | data | | | data | +| | data | +| | data | +| | data | +| | data | +| | data | +| | data | | | data | | | data | | | data | | | data | +| | dataViews | +| | dataViews | | | expressions | | | expressions | | | expressions | +| | expressions | | | expressions | | | expressions | +| | expressions | | | expressions | | | expressions | | | expressions | | | expressions | | | expressions | +| | expressions | | | licensing | | | licensing | | | licensing | @@ -195,5 +212,4 @@ Safe to remove. | | reporting | | | taskManager | | | core | -| | core | | | core | \ No newline at end of file diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index e226f7c46d494b..1a9c18eec9eaca 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-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -13,8 +13,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder) | 8.1 | -| | [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) | - | +| | [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 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=authc) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=authz) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=index), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=index) | - | @@ -34,11 +33,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode) | 8.1 | -| | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode) | 8.1 | -| | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=nodeBuilder), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=nodeBuilder), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=nodeBuilder) | 8.1 | -| | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode) | 8.1 | -| | [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.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) | - | @@ -48,10 +44,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery) | 8.1 | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/plugin.ts#:~:text=environment) | - | -| | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | - | -| | [license_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/context/license/license_context.tsx#:~:text=license%24) | - | -| | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/plugin.ts#:~:text=environment) | 8.8.0 | +| | [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks), [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks), [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks) | - | +| | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | +| | [license_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/context/license/license_context.tsx#:~:text=license%24) | 8.8.0 | +| | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | @@ -66,7 +63,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getFunctions), [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 | - | +| | [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/target/types/public/functions/index.d.ts#:~:text=Render), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/target/types/public/functions/index.d.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), [state.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/target/types/types/state.d.ts#:~:text=Render), [state.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/target/types/types/state.d.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)+ 8 more | - | | | [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.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), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.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), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getFunctions), [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) | - | @@ -79,11 +76,19 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud/public/plugin.tsx#:~:text=environment) | - | +| | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud/public/plugin.tsx#:~:text=environment) | 8.8.0 | | | [chat.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud/server/routes/chat.ts#:~:text=authc) | - | +## 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 | @@ -96,7 +101,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/public/plugin.ts#:~:text=license%24) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/public/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -104,19 +109,20 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [load_saved_dashboard_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts#:~:text=IndexPattern), [use_dashboard_app_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts#:~:text=IndexPattern), [load_saved_dashboard_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts#:~:text=IndexPattern), [use_dashboard_app_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts#:~:text=IndexPattern) | - | | | [export_csv_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/export_csv_action.tsx#:~:text=fieldFormats) | - | | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | -| | [load_saved_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/load_saved_dashboard_state.ts#:~:text=ensureDefaultDataView), [load_saved_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/load_saved_dashboard_state.ts#:~:text=ensureDefaultDataView) | - | | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | +| | [load_saved_dashboard_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts#:~:text=IndexPattern), [use_dashboard_app_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts#:~:text=IndexPattern), [load_saved_dashboard_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts#:~:text=IndexPattern), [use_dashboard_app_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts#:~:text=IndexPattern) | - | +| | [load_saved_dashboard_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/lib/load_saved_dashboard_state.d.ts#:~:text=IndexPattern), [use_dashboard_app_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/application/hooks/use_dashboard_app_state.d.ts#:~:text=IndexPattern) | - | | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | -| | [load_saved_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/load_saved_dashboard_state.ts#:~:text=ensureDefaultDataView) | - | | | [kibana_react.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/kibana_react.ts#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton) | - | -| | [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_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 | - | -| | [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObjectClass) | - | -| | [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings) | - | -| | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [dashboard_router.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/dashboard_router.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | - | -| | [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning) | - | +| | [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) | 8.8.0 | +| | [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 | +| | [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObjectClass) | 8.8.0 | +| | [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings) | 8.8.0 | +| | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [dashboard_router.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/dashboard_router.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave), [types.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/types.d.ts#:~:text=onAppLeave) | 8.8.0 | +| | [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning) | 8.8.0 | @@ -125,17 +131,17 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField)+ 16 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 25 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 29 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 89 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 90 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/ui/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/ui/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/ui/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/ui/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType)+ 43 more | 8.2 | | | [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField)+ 16 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IIndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IIndexPattern)+ 64 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternAttributes), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternAttributes), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternAttributes) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 25 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 29 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 89 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 90 more | - | | | [aggs_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/aggs/aggs_service.ts#:~:text=indexPatternsServiceFactory), [esaggs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/expressions/esaggs.ts#:~:text=indexPatternsServiceFactory), [search_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/search_service.ts#:~:text=indexPatternsServiceFactory) | - | | | [data_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions), [data_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions) | - | @@ -145,10 +151,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | +| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode)+ 2 more | 8.1 | | | [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder)+ 2 more | 8.1 | -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | +| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode)+ 2 more | 8.1 | +| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode)+ 2 more | 8.1 | +| | [get_columns.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks) | - | | | [session_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/session_service.ts#:~:text=authc) | - | @@ -166,6 +173,17 @@ warning: This document is auto-generated and is meant to be viewed inside our ex +## dataViewFieldEditor + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern), [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern), [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern), [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern) | - | +| | [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=fieldFormats) | - | +| | [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern), [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern), [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern), [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern) | - | +| | [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern), [field_format_editor.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_field_editor/target/types/public/components/field_format_editor/field_format_editor.d.ts#:~:text=IndexPattern) | - | + + + ## dataViewManagement | Deprecated API | Reference location(s) | Remove By | @@ -218,42 +236,25 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## dataVisualizer - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [geo_point_content_with_map.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx#:~:text=IndexPattern), [geo_point_content_with_map.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx#:~:text=IndexPattern), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPattern), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPattern), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPattern), [actions_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx#:~:text=IndexPattern)+ 44 more | - | -| | [field_data_row.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts#:~:text=IndexPatternField), [field_data_row.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts#:~:text=IndexPatternField), [field_types_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts#:~:text=IndexPatternField), [field_types_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts#:~:text=IndexPatternField), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPatternField), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPatternField), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPatternField), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPatternField), [grid_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx#:~:text=IndexPatternField), [grid_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx#:~:text=IndexPatternField)+ 20 more | - | -| | [file_data_visualizer.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/file_data_visualizer/file_data_visualizer.tsx#:~:text=indexPatterns), [index_data_visualizer.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx#:~:text=indexPatterns) | - | -| | [field_data_row.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts#:~:text=IndexPatternField), [field_data_row.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts#:~:text=IndexPatternField), [field_types_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts#:~:text=IndexPatternField), [field_types_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts#:~:text=IndexPatternField), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPatternField), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPatternField), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPatternField), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPatternField), [grid_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx#:~:text=IndexPatternField), [grid_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx#:~:text=IndexPatternField)+ 20 more | - | -| | [geo_point_content_with_map.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx#:~:text=IndexPattern), [geo_point_content_with_map.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx#:~:text=IndexPattern), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPattern), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPattern), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPattern), [actions_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx#:~:text=IndexPattern)+ 44 more | - | -| | [field_data_row.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts#:~:text=IndexPatternField), [field_data_row.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/types/field_data_row.ts#:~:text=IndexPatternField), [field_types_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts#:~:text=IndexPatternField), [field_types_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts#:~:text=IndexPatternField), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPatternField), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPatternField), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPatternField), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPatternField), [grid_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx#:~:text=IndexPatternField), [grid_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx#:~:text=IndexPatternField)+ 5 more | - | -| | [geo_point_content_with_map.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx#:~:text=IndexPattern), [geo_point_content_with_map.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/geo_point_content_with_map/geo_point_content_with_map.tsx#:~:text=IndexPattern), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPattern), [index_based_expanded_row.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/expanded_row/index_based_expanded_row.tsx#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [saved_search_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/saved_search_utils.ts#:~:text=IndexPattern), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPattern), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=IndexPattern), [actions_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx#:~:text=IndexPattern)+ 17 more | - | - - - ## discover | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField), [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField) | - | -| | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=IndexPatternAttributes), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=IndexPatternAttributes), [discover_main_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_app.tsx#:~:text=IndexPatternAttributes), [discover_main_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_app.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes) | - | +| | [use_discover_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts#:~:text=IndexPattern), [use_discover_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts#:~:text=IndexPattern) | - | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create) | - | | | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | -| | [build_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/build_services.ts#:~:text=indexPatterns), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=indexPatterns), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=indexPatterns), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=indexPatterns) | - | +| | [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=indexPatterns) | - | | | [histogram.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/chart/histogram.tsx#:~:text=fieldFormats) | - | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=esFilters), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=esFilters) | 8.1 | -| | [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter) | 8.1 | -| | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=IndexPatternAttributes), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=IndexPatternAttributes), [discover_main_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_app.tsx#:~:text=IndexPatternAttributes), [discover_main_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_app.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=IndexPatternAttributes), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=IndexPatternAttributes), [discover_main_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_app.tsx#:~:text=IndexPatternAttributes)+ 4 more | - | -| | [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField), [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField) | - | -| | [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter) | 8.1 | +| | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter) | 8.1 | +| | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter) | 8.1 | +| | [use_discover_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts#:~:text=IndexPattern), [use_discover_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts#:~:text=IndexPattern) | - | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create) | - | | | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | -| | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=IndexPatternAttributes), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=IndexPatternAttributes), [discover_main_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_app.tsx#:~:text=IndexPatternAttributes), [discover_main_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_app.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes), [discover_main_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/discover_main_route.tsx#:~:text=IndexPatternAttributes) | - | -| | [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [discover_field_visualize_inner.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/discover_field_visualize_inner.tsx#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField), [fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/sidebar/__stories__/fields.ts#:~:text=IndexPatternField) | - | -| | [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter) | 8.1 | -| | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal) | - | -| | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=executeTriggerActions), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=executeTriggerActions), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=executeTriggerActions) | - | +| | [use_discover_state.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/main/utils/use_discover_state.d.ts#:~:text=IndexPattern) | - | +| | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter) | 8.1 | +| | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | +| | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=executeTriggerActions), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=executeTriggerActions), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=executeTriggerActions), [search_embeddable_factory.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/embeddable/search_embeddable_factory.d.ts#:~:text=executeTriggerActions) | - | | | [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric) | - | | | [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric) | - | @@ -276,7 +277,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [attribute_service.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal) | - | +| | [attribute_service.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [container.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [explicit_input.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/tests/explicit_input.test.ts#:~:text=executeTriggerActions) | - | @@ -297,11 +298,19 @@ warning: This document is auto-generated and is meant to be viewed inside our ex +## esUiShared + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [view_api_request_flyout.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/es_ui_shared/public/components/view_api_request_flyout/view_api_request_flyout.tsx#:~:text=RedirectAppLinks), [view_api_request_flyout.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/es_ui_shared/public/components/view_api_request_flyout/view_api_request_flyout.tsx#:~:text=RedirectAppLinks), [view_api_request_flyout.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/es_ui_shared/public/components/view_api_request_flyout/view_api_request_flyout.tsx#:~:text=RedirectAppLinks) | - | + + + ## expressionPartitionVis | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats) | - | +| | [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats), [get_layers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts#:~:text=fieldFormats) | - | @@ -317,10 +326,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | - | +| | [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/integrations/app.tsx#:~:text=RedirectAppLinks)+ 5 more | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | +| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/public/applications/fleet/index.d.ts#:~:text=appBasePath), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/public/applications/integrations/index.d.ts#:~:text=appBasePath) | 8.8.0 | +| | [plugin.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/server/plugin.d.ts#:~:text=AsyncPlugin), [plugin.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/server/plugin.d.ts#:~:text=AsyncPlugin) | 8.8.0 | @@ -338,9 +349,17 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [app_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/types/app_state.ts#:~:text=IndexPattern), [app_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/types/app_state.ts#:~:text=IndexPattern), [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=IndexPattern), [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=IndexPattern), [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=IndexPattern), [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=IndexPattern), [datasource.sagas.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.sagas.ts#:~:text=IndexPattern), [datasource.sagas.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.sagas.ts#:~:text=IndexPattern), [persistence.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/persistence.ts#:~:text=IndexPattern), [persistence.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/persistence.ts#:~:text=IndexPattern)+ 19 more | - | | | [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | | | [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | -| | [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | - | -| | [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings), [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | - | +| | [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | +| | [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings), [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings) | 8.8.0 | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | + + + +## home + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/home/public/application/application.tsx#:~:text=RedirectAppLinks), [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/home/public/application/application.tsx#:~:text=RedirectAppLinks), [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/home/public/application/application.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks) | - | @@ -348,7 +367,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/services/license.ts#:~:text=license%24) | - | +| | [shared_imports.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/public/shared_imports.ts#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/public/application/index.tsx#:~:text=RedirectAppLinks) | - | +| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/services/license.ts#:~:text=license%24) | 8.8.0 | @@ -356,7 +376,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [editor.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/editor.tsx#:~:text=indexPatterns), [log_stream.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream.tsx#:~:text=indexPatterns), [log_stream.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream.tsx#:~:text=indexPatterns), [logs_overview_fetchers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/logs_overview_fetchers.ts#:~:text=indexPatterns), [redirect_to_node_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx#:~:text=indexPatterns), [use_kibana_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts#:~:text=indexPatterns), [page_providers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/page_providers.tsx#:~:text=indexPatterns), [logs_overview_fetches.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/logs_overview_fetches.test.ts#:~:text=indexPatterns) | - | +| | [redirect_to_node_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/link_to/redirect_to_node_logs.tsx#:~:text=indexPatterns), [editor.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/editor.tsx#:~:text=indexPatterns), [log_stream.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream.tsx#:~:text=indexPatterns), [log_stream.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream.tsx#:~:text=indexPatterns), [logs_overview_fetchers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/logs_overview_fetchers.ts#:~:text=indexPatterns), [use_kibana_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts#:~:text=indexPatterns), [page_providers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/page_providers.tsx#:~:text=indexPatterns), [logs_overview_fetches.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/utils/logs_overview_fetches.test.ts#:~:text=indexPatterns) | - | | | [kibana_framework_adapter.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts#:~:text=indexPatternsServiceFactory), [log_entries_search_strategy.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/services/log_entries/log_entries_search_strategy.ts#:~:text=indexPatternsServiceFactory), [log_entry_search_strategy.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/services/log_entries/log_entry_search_strategy.ts#:~:text=indexPatternsServiceFactory) | - | @@ -365,9 +385,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern), [controls_tab.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts#:~:text=IndexPattern), [controls_tab.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts#:~:text=IndexPattern), [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern)+ 2 more | - | | | [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=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) | - | +| | [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern), [controls_tab.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts#:~:text=IndexPattern), [controls_tab.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts#:~:text=IndexPattern), [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern)+ 2 more | - | | | [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 | +| | [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [create_search_source.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/control/create_search_source.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern), [get_index_pattern_mock.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/test_utils/get_index_pattern_mock.d.ts#:~:text=IndexPattern), [controls_tab.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts#:~:text=IndexPattern), [controls_tab.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/target/types/public/components/editor/controls_tab.d.ts#:~:text=IndexPattern) | - | @@ -375,7 +398,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | - | +| | [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=RedirectAppLinks), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=RedirectAppLinks), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=RedirectAppLinks), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=RedirectAppLinks)+ 1 more | - | +| | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | 8.8.0 | @@ -383,7 +407,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process) | - | +| | [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process) | 8.8.0 | @@ -391,22 +415,19 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPatternsContract), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPatternsContract), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/utils.ts#:~:text=IndexPatternsContract), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/utils.ts#:~:text=IndexPatternsContract), [loader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts#:~:text=IndexPatternsContract), [loader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts#:~:text=IndexPatternsContract), [embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable_factory.ts#:~:text=IndexPatternsContract), [embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable_factory.ts#:~:text=IndexPatternsContract), [loader.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts#:~:text=IndexPatternsContract), [loader.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts#:~:text=IndexPatternsContract)+ 18 more | - | -| | [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [loader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/utils.ts#:~:text=IndexPattern)+ 22 more | - | -| | [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField) | - | -| | [datapanel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx#:~:text=indexPatterns), [datapanel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx#:~:text=indexPatterns), [datapanel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx#:~:text=indexPatterns), [datapanel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/datapanel.tsx#:~:text=indexPatterns), [indexpattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx#:~:text=indexPatterns), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=indexPatterns), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=indexPatterns), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/plugin.ts#:~:text=indexPatterns), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/plugin.ts#:~:text=indexPatterns) | - | +| | [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPatternsContract), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPatternsContract), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPatternsContract), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPatternsContract) | - | +| | [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern), [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern) | - | +| | [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField) | - | | | [ranges.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx#:~:text=fieldFormats), [droppable.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts#:~:text=fieldFormats) | - | -| | [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPatternsContract), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPatternsContract), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/utils.ts#:~:text=IndexPatternsContract), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/utils.ts#:~:text=IndexPatternsContract), [loader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts#:~:text=IndexPatternsContract), [loader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts#:~:text=IndexPatternsContract), [embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable_factory.ts#:~:text=IndexPatternsContract), [embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable_factory.ts#:~:text=IndexPatternsContract), [loader.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts#:~:text=IndexPatternsContract), [loader.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts#:~:text=IndexPatternsContract)+ 18 more | - | -| | [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/plugin.ts#:~:text=ensureDefaultDataView), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/plugin.ts#:~:text=ensureDefaultDataView) | - | -| | [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [loader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/utils.ts#:~:text=IndexPattern)+ 22 more | - | -| | [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField), [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=IndexPatternField) | - | -| | [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [existing_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/existing_fields.test.ts#:~:text=IndexPattern), [loader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=IndexPattern), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/utils.ts#:~:text=IndexPattern)+ 6 more | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/plugin.ts#:~:text=ensureDefaultDataView) | - | -| | [field_stats.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/routes/field_stats.ts#:~:text=indexPatternsServiceFactory) | - | -| | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | - | -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | - | -| | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning), [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning) | - | +| | [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPatternsContract), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPatternsContract), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPatternsContract), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPatternsContract) | - | +| | [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField) | - | +| | [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern), [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern) | - | +| | [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField), [field_stats.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/server/routes/field_stats.d.ts#:~:text=IndexPatternField) | - | +| | [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [embeddable.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/embeddable/embeddable.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern), [utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/utils.d.ts#:~:text=IndexPattern) | - | +| | [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks), [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks), [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks) | - | +| | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/check_for_duplicate_title.d.ts#:~:text=SavedObject), [check_for_duplicate_title.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/check_for_duplicate_title.d.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.d.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.d.ts#:~:text=SavedObject) | 8.8.0 | +| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | +| | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning), [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | @@ -414,7 +435,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/license_management/public/plugin.ts#:~:text=license%24) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/license_management/public/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -422,7 +443,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/logstash/public/plugin.ts#:~:text=license%24) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/logstash/public/plugin.ts#:~:text=license%24) | 8.8.0 | | | [save.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/logstash/server/routes/pipeline/save.ts#:~:text=authc) | - | @@ -431,7 +452,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | - | +| | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath), [application.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/management/target/types/public/application.d.ts#:~:text=appBasePath) | 8.8.0 | @@ -440,31 +461,31 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract) | - | -| | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern)+ 4 more | - | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 84 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract) | - | +| | [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPattern), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPattern), [percentile_agg_field.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts#:~:text=IndexPattern), [percentile_agg_field.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts#:~:text=IndexPattern), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=IndexPattern), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_source.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts#:~:text=IndexPattern), [es_source.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts#:~:text=IndexPattern)+ 82 more | - | +| | [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 194 more | - | | | [es_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch) | 8.1 | | | [kibana_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/kibana_services.ts#:~:text=indexPatterns) | - | | | [locators.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/locators.test.ts#:~:text=esFilters), [locators.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/locators.test.ts#:~:text=esFilters) | 8.1 | -| | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter) | 8.1 | -| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract) | - | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 84 more | - | +| | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter) | 8.1 | +| | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter) | 8.1 | +| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/lazy_load_bundle/index.d.ts#:~:text=IndexPatternsContract) | - | +| | [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 194 more | - | | | [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - | -| | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern)+ 4 more | - | +| | [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPattern), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPattern), [percentile_agg_field.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts#:~:text=IndexPattern), [percentile_agg_field.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts#:~:text=IndexPattern), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=IndexPattern), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_source.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts#:~:text=IndexPattern), [es_source.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts#:~:text=IndexPattern)+ 82 more | - | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | -| | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter) | 8.1 | | | [es_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch) | 8.1 | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 37 more | - | -| | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern) | - | +| | [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 92 more | - | +| | [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPattern), [es_agg_utils.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/common/elasticsearch_util/es_agg_utils.d.ts#:~:text=IndexPattern), [percentile_agg_field.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts#:~:text=IndexPattern), [percentile_agg_field.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/fields/agg/percentile_agg_field.d.ts#:~:text=IndexPattern), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=IndexPattern), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_source.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts#:~:text=IndexPattern), [es_source.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts#:~:text=IndexPattern)+ 36 more | - | | | [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | -| | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter) | 8.1 | +| | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter) | 8.1 | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | | | [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=indexPatternsServiceFactory), [indexing_routes.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/indexing_routes.ts#:~:text=indexPatternsServiceFactory) | - | | | [map_container.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/connected_components/map_container/map_container.tsx#:~:text=ExitFullScreenButton), [map_container.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/connected_components/map_container/map_container.tsx#:~:text=ExitFullScreenButton) | - | -| | [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings) | - | -| | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | - | -| | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | - | +| | [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings) | 8.8.0 | +| | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave), [render_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/render_app.d.ts#:~:text=onAppLeave), [map_page.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_page.d.ts#:~:text=onAppLeave), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=onAppLeave) | 8.8.0 | +| | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | @@ -472,8 +493,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=license%24) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=refresh) | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=license%24) | 8.8.0 | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=refresh) | 8.8.0 | @@ -481,12 +502,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [check_license.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24) | - | +| | [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks) | - | +| | [check_license.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24) | 8.8.0 | | | [annotations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/routes/annotations.ts#:~:text=authc) | - | | | [initialization.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/saved_objects/initialization/initialization.ts#:~:text=authz), [sync_task.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/saved_objects/sync_task.ts#:~:text=authz), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=authz), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=authz) | - | -| | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | - | -| | [errors.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req), [errors.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req) | - | +| | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | 8.8.0 | +| | [errors.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req), [errors.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req) | 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. | @@ -494,11 +519,19 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern) | - | +| | [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [with_kuery_autocompletion.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts#:~:text=IIndexPattern), [with_kuery_autocompletion.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts#:~:text=IIndexPattern)+ 2 more | - | | | [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=indexPatterns), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=indexPatterns) | - | -| | [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern)+ 6 more | - | -| | [legacy_shims.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/legacy_shims.ts#:~:text=injectedMetadata) | - | -| | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | - | +| | [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [with_kuery_autocompletion.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts#:~:text=IIndexPattern), [with_kuery_autocompletion.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/target/types/public/components/kuery_bar/with_kuery_autocompletion.d.ts#:~:text=IIndexPattern)+ 14 more | - | +| | [legacy_shims.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/legacy_shims.ts#:~:text=injectedMetadata) | 8.8.0 | +| | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | + + + +## observability + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks) | - | @@ -506,8 +539,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24) | - | -| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/server/services/license.ts#:~:text=license%24) | - | +| | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24) | 8.8.0 | +| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/server/services/license.ts#:~:text=license%24) | 8.8.0 | @@ -515,7 +548,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [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) | - | +| | [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 | @@ -523,7 +556,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/remote_clusters/server/plugin.ts#:~:text=license%24) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/remote_clusters/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -531,7 +564,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/rollup/server/services/license.ts#:~:text=license%24) | - | +| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/rollup/server/services/license.ts#:~:text=license%24) | 8.8.0 | @@ -550,6 +583,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks) | - | | | [resolve_import_errors.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts#:~:text=createNewCopy) | - | | | [resolve_import_errors.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts#:~:text=createNewCopy) | - | @@ -567,7 +601,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject) | - | +| | [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject) | 8.8.0 | @@ -575,8 +609,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/server/plugin.ts#:~:text=license%24) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24) | 8.8.0 | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -584,17 +618,25 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | - | -| | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | - | -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | - | -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | - | -| | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | - | -| | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | - | -| | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | - | -| | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | - | -| | [logout_app.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | - | -| | [logout_app.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | - | +| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 + +This is relied on by the reporting feature, and should be removed once reporting +migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | +| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 + +This is relied on by the reporting feature, and should be removed once reporting +migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | +| | [app_authorization.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 14 more | 8.8.0 | +| | [authorization_service.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 | +| | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | +| | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 | +| | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 | +| | [logout_app.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | +| | [logout_app.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 | @@ -603,11 +645,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [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) | - | -| | [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), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | - | -| | [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), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | - | +| | [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), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 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), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 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) | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler)+ 3 more | - | +| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | 8.8.0 | +| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler)+ 3 more | 8.8.0 | @@ -615,7 +657,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/snapshot_restore/server/services/license.ts#:~:text=license%24) | - | +| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/snapshot_restore/server/services/license.ts#:~:text=license%24) | 8.8.0 | @@ -623,7 +665,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24) | - | +| | [spaces_management_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/management/spaces_management_app.tsx#:~:text=RedirectAppLinks), [spaces_management_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/management/spaces_management_app.tsx#:~:text=RedirectAppLinks), [spaces_management_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/management/spaces_management_app.tsx#:~:text=RedirectAppLinks) | - | +| | [on_post_auth_interceptor.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.ts#:~:text=getKibanaFeatures), [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=getKibanaFeatures), [on_post_auth_interceptor.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | +| | [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24) | 8.8.0 | | | [copy_to_space_flyout_internal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx#:~:text=createNewCopy) | - | | | [copy_to_space_flyout_internal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx#:~:text=createNewCopy) | - | @@ -633,20 +677,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPatternsContract), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPatternsContract), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPatternsContract), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPatternsContract) | - | -| | [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern) | - | -| | [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=IIndexPattern), [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=IIndexPattern), [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=IIndexPattern), [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=IIndexPattern), [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=IIndexPattern), [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=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=IIndexPattern)+ 1 more | - | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [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=IFieldType), [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=IFieldType)+ 14 more | 8.2 | +| | [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPatternsContract), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPatternsContract), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPatternsContract), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPatternsContract) | - | +| | [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern) | - | +| | [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType) | 8.2 | | | [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) | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=esKuery) | 8.1 | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=esQuery) | 8.1 | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [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=IFieldType), [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=IFieldType)+ 38 more | 8.2 | -| | [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=IIndexPattern), [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=IIndexPattern), [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=IIndexPattern), [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=IIndexPattern), [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=IIndexPattern), [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=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=IIndexPattern)+ 12 more | - | -| | [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPatternsContract), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPatternsContract), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPatternsContract), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPatternsContract) | - | -| | [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern) | - | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [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=IFieldType), [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=IFieldType)+ 14 more | 8.2 | -| | [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern), [geo_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.tsx#:~:text=IndexPattern) | - | +| | [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType) | 8.2 | +| | [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPatternsContract), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPatternsContract), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPatternsContract), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPatternsContract) | - | +| | [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern) | - | +| | [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType) | 8.2 | +| | [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern), [geo_index_pattern_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/geo_index_pattern_select.d.ts#:~:text=IndexPattern) | - | @@ -654,18 +694,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract) | - | -| | [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [wizard.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx#:~:text=IndexPattern), [wizard.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx#:~:text=IndexPattern), [get_pivot_dropdown_options.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts#:~:text=IndexPattern), [get_pivot_dropdown_options.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts#:~:text=IndexPattern), [filter_agg_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx#:~:text=IndexPattern), [filter_agg_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx#:~:text=IndexPattern)+ 30 more | - | -| | [es_index_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/services/es_index_service.ts#:~:text=IIndexPattern), [es_index_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/services/es_index_service.ts#:~:text=IIndexPattern), [transforms.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/routes/api/transforms.ts#:~:text=IIndexPattern), [transforms.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/routes/api/transforms.ts#:~:text=IIndexPattern) | - | -| | [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternAttributes), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternAttributes) | - | -| | [step_create_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx#:~:text=indexPatterns), [step_details_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_details/step_details_form.tsx#:~:text=indexPatterns), [use_search_items.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/use_search_items.ts#:~:text=indexPatterns), [use_clone_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/transform_management/components/action_clone/use_clone_action.tsx#:~:text=indexPatterns), [use_action_discover.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/transform_management/components/action_discover/use_action_discover.tsx#:~:text=indexPatterns), [edit_transform_flyout_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/transform_management/components/edit_transform_flyout/edit_transform_flyout_form.tsx#:~:text=indexPatterns), [use_edit_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/transform_management/components/action_edit/use_edit_action.tsx#:~:text=indexPatterns) | - | -| | [es_index_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/services/es_index_service.ts#:~:text=IIndexPattern), [es_index_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/services/es_index_service.ts#:~:text=IIndexPattern), [transforms.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/routes/api/transforms.ts#:~:text=IIndexPattern), [transforms.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/routes/api/transforms.ts#:~:text=IIndexPattern), [es_index_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/services/es_index_service.ts#:~:text=IIndexPattern), [es_index_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/services/es_index_service.ts#:~:text=IIndexPattern), [transforms.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/routes/api/transforms.ts#:~:text=IIndexPattern), [transforms.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/routes/api/transforms.ts#:~:text=IIndexPattern) | - | -| | [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternAttributes), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternAttributes), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternAttributes), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternAttributes) | - | -| | [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternsContract) | - | -| | [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [wizard.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx#:~:text=IndexPattern), [wizard.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx#:~:text=IndexPattern), [get_pivot_dropdown_options.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts#:~:text=IndexPattern), [get_pivot_dropdown_options.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts#:~:text=IndexPattern), [filter_agg_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx#:~:text=IndexPattern), [filter_agg_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx#:~:text=IndexPattern)+ 30 more | - | -| | [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternAttributes), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/hooks/use_search_items/common.ts#:~:text=IndexPatternAttributes) | - | -| | [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [index_pattern.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/common/types/index_pattern.ts#:~:text=IndexPattern), [wizard.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx#:~:text=IndexPattern), [wizard.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/wizard/wizard.tsx#:~:text=IndexPattern), [get_pivot_dropdown_options.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts#:~:text=IndexPattern), [get_pivot_dropdown_options.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts#:~:text=IndexPattern), [filter_agg_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx#:~:text=IndexPattern), [filter_agg_form.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx#:~:text=IndexPattern)+ 10 more | - | -| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | - | +| | [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 | @@ -673,7 +702,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [reindex_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24) | - | +| | [app_context.mock.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts#:~:text=IndexPattern), [app_context.mock.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts#:~:text=IndexPattern) | - | +| | [app_context.mock.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts#:~:text=IndexPattern), [app_context.mock.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts#:~:text=IndexPattern) | - | +| | [app_context.mock.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/target/types/__jest__/client_integration/helpers/app_context.mock.d.ts#:~:text=IndexPattern) | - | +| | [shared_imports.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/public/shared_imports.ts#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/public/application/app.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/public/application/app.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/public/application/app.tsx#:~:text=RedirectAppLinks) | - | +| | [reindex_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24) | 8.8.0 | @@ -685,6 +718,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=indexPatterns) | - | | | [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern) | - | | | [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern) | - | +| | [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks) | - | @@ -705,6 +739,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | | | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | | | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | +| | [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks), [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks), [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks) | - | @@ -712,12 +747,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 16 more | - | -| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 26 more | - | -| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 26 more | - | -| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 16 more | - | -| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 8 more | - | -| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 3 more | - | +| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 24 more | - | +| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 38 more | - | +| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 38 more | - | +| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 24 more | - | +| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 14 more | - | +| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 7 more | - | @@ -746,37 +781,18 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## visTypeTimelion - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [plugin_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/plugin_services.ts#:~:text=IndexPatternsContract), [plugin_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/plugin_services.ts#:~:text=IndexPatternsContract), [timelion_expression_input_helpers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts#:~:text=IndexPatternsContract), [timelion_expression_input_helpers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts#:~:text=IndexPatternsContract), [plugin_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/plugin_services.ts#:~:text=IndexPatternsContract), [plugin_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/plugin_services.ts#:~:text=IndexPatternsContract), [timelion_expression_input_helpers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts#:~:text=IndexPatternsContract), [timelion_expression_input_helpers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts#:~:text=IndexPatternsContract) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/plugin.ts#:~:text=indexPatterns) | - | -| | [plugin_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/plugin_services.ts#:~:text=IndexPatternsContract), [plugin_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/plugin_services.ts#:~:text=IndexPatternsContract), [timelion_expression_input_helpers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts#:~:text=IndexPatternsContract), [timelion_expression_input_helpers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts#:~:text=IndexPatternsContract), [plugin_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/plugin_services.ts#:~:text=IndexPatternsContract), [plugin_services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/plugin_services.ts#:~:text=IndexPatternsContract), [timelion_expression_input_helpers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts#:~:text=IndexPatternsContract), [timelion_expression_input_helpers.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/components/timelion_expression_input_helpers.test.ts#:~:text=IndexPatternsContract) | - | -| | [run.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/server/routes/run.ts#:~:text=indexPatternsServiceFactory) | - | - - - ## visTypeTimeseries | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=IndexPatternsService), [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=IndexPatternsService), [default_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts#:~:text=IndexPatternsService), [default_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts#:~:text=IndexPatternsService), [cached_index_pattern_fetcher.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts#:~:text=IndexPatternsService), [cached_index_pattern_fetcher.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts#:~:text=IndexPatternsService), [rollup_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts#:~:text=IndexPatternsService), [rollup_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts#:~:text=IndexPatternsService), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/types.ts#:~:text=IndexPatternsService), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/types.ts#:~:text=IndexPatternsService)+ 44 more | - | -| | [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/types/index.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/types/index.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern)+ 56 more | - | -| | [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField)+ 2 more | - | -| | [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=indexPatterns), [combo_box_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/combo_box_select.tsx#:~:text=indexPatterns), [query_bar_wrapper.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/query_bar_wrapper.tsx#:~:text=indexPatterns), [annotation_row.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/annotation_row.tsx#:~:text=indexPatterns), [metrics_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/metrics_type.ts#:~:text=indexPatterns), [metrics_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/metrics_type.ts#:~:text=indexPatterns), [convert_series_to_datatable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.ts#:~:text=indexPatterns), [timeseries_visualization.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/timeseries_visualization.tsx#:~:text=indexPatterns), [metrics_type.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/metrics_type.test.ts#:~:text=indexPatterns) | - | +| | [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/plugin.ts#:~:text=fieldFormats) | - | -| | [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField)+ 2 more | - | -| | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=IndexPatternsService), [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=IndexPatternsService), [default_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts#:~:text=IndexPatternsService), [default_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts#:~:text=IndexPatternsService), [cached_index_pattern_fetcher.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts#:~:text=IndexPatternsService), [cached_index_pattern_fetcher.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts#:~:text=IndexPatternsService), [rollup_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts#:~:text=IndexPatternsService), [rollup_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts#:~:text=IndexPatternsService), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/types.ts#:~:text=IndexPatternsService), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/types.ts#:~:text=IndexPatternsService)+ 44 more | - | -| | [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/types/index.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/types/index.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern)+ 56 more | - | +| | [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern) | - | | | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields), [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | -| | [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField), [convert_series_to_datatable.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/lib/convert_series_to_datatable.test.ts#:~:text=IndexPatternField) | - | -| | [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [cached_index_pattern_fetcher.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/types/index.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/types/index.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern), [index_patterns_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/common/index_patterns_utils.test.ts#:~:text=IndexPattern)+ 23 more | - | -| | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=IndexPatternsService), [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=IndexPatternsService), [default_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts#:~:text=IndexPatternsService), [default_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/default_search_strategy.ts#:~:text=IndexPatternsService), [cached_index_pattern_fetcher.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts#:~:text=IndexPatternsService), [cached_index_pattern_fetcher.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/lib/cached_index_pattern_fetcher.ts#:~:text=IndexPatternsService), [rollup_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts#:~:text=IndexPatternsService), [rollup_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/rollup_search_strategy.ts#:~:text=IndexPatternsService), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/types.ts#:~:text=IndexPatternsService), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/types.ts#:~:text=IndexPatternsService)+ 44 more | - | +| | [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern), [convert_series_to_datatable.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/target/types/public/application/components/lib/convert_series_to_datatable.d.ts#:~:text=IndexPattern) | - | | | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/plugin.ts#:~:text=fieldFormats) | - | | | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/plugin.ts#:~:text=indexPatternsServiceFactory) | - | @@ -784,12 +800,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern) | - | -| | [search_api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.ts#:~:text=indexPatterns), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=indexPatterns), [search_api.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.test.ts#:~:text=indexPatterns), [search_api.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.test.ts#:~:text=indexPatterns), [search_api.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.test.ts#:~:text=indexPatterns), [view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_view/vega_map_view/view.test.ts#:~:text=indexPatterns) | - | -| | [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern) | - | -| | [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern), [extract_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/lib/extract_index_pattern.ts#:~:text=IndexPattern) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | - | -| | [search_api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.ts#:~:text=injectedMetadata), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | 8.8.0 | +| | [search_api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.ts#:~:text=injectedMetadata), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata), [search_api.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/target/types/public/data_model/search_api.d.ts#:~:text=injectedMetadata) | 8.8.0 | @@ -817,16 +829,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern)+ 16 more | - | -| | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=indexPatterns), [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=indexPatterns), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/plugin.ts#:~:text=indexPatterns), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/plugin.ts#:~:text=indexPatterns) | - | -| | [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [timeseries_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [timeseries_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE)+ 8 more | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/plugin.ts#:~:text=ensureDefaultDataView), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/plugin.ts#:~:text=ensureDefaultDataView) | - | -| | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern)+ 16 more | - | -| | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=IndexPattern)+ 3 more | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/plugin.ts#:~:text=ensureDefaultDataView) | - | -| | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | - | -| | [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings), [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings) | - | -| | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | - | +| | [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern), [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern), [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern), [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern) | - | +| | [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern), [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern), [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern), [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern) | - | +| | [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern), [base_vis_type.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/vis_types/base_vis_type.d.ts#:~:text=IndexPattern) | - | +| | [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks) | - | +| | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | +| | [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings), [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings) | 8.8.0 | +| | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave), [app.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/visualize_app/app.d.ts#:~:text=onAppLeave), [index.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/visualize_app/index.d.ts#:~:text=onAppLeave), [visualize_editor_common.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/visualize_app/components/visualize_editor_common.d.ts#:~:text=onAppLeave), [visualize_top_nav.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/visualize_app/components/visualize_top_nav.d.ts#:~:text=onAppLeave) | 8.8.0 | @@ -834,4 +843,4 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | - | \ No newline at end of file +| | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 | \ No newline at end of file diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index c7bd86aaca030b..eab23cbf89f857 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-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -14,6 +14,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| | apm | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery) | 8.1 | +| apm | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/plugin.ts#:~:text=environment) | 8.8.0 | +| apm | | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | +| apm | | [license_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/context/license/license_context.tsx#:~:text=license%24) | 8.8.0 | +| apm | | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | @@ -24,13 +28,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.2 | | dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 66 more | 8.2 | | dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.2 | -| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | -| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | +| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode)+ 2 more | 8.1 | | dataEnhanced | | [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder)+ 2 more | 8.1 | -| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | +| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode)+ 2 more | 8.1 | +| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode)+ 2 more | 8.1 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | +| embeddable | | [attribute_service.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | @@ -39,27 +44,57 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| | graph | | [search_bar.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/search_bar.tsx#:~:text=esKuery), [search_bar.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/search_bar.tsx#:~:text=esKuery), [search_bar.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/search_bar.tsx#:~:text=esKuery) | 8.1 | +| graph | | [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | +| graph | | [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings), [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings) | 8.8.0 | +| graph | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | | discover | | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | | discover | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=esFilters), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=esFilters), [explore_data_chart_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#:~:text=esFilters), [explore_data_chart_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#:~:text=esFilters) | 8.1 | -| discover | | [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter) | 8.1 | -| discover | | [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter) | 8.1 | +| discover | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter)+ 4 more | 8.1 | +| discover | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter)+ 4 more | 8.1 | | discover | | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | -| discover | | [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=Filter) | 8.1 | +| discover | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context_state.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/context_state.test.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [context.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/target/types/public/application/context/services/context.d.ts#:~:text=Filter), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=Filter)+ 4 more | 8.1 | | discoverEnhanced | | [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=RangeFilter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=RangeFilter) | 8.1 | | discoverEnhanced | | [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=RangeFilter), [explore_data_chart_action.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.test.ts#:~:text=RangeFilter) | 8.1 | +## Fleet + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | +| fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | +| fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | +| fleet | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/public/applications/fleet/index.d.ts#:~:text=appBasePath), [index.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/public/applications/integrations/index.d.ts#:~:text=appBasePath) | 8.8.0 | +| fleet | | [plugin.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/server/plugin.d.ts#:~:text=AsyncPlugin), [plugin.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/target/types/server/plugin.d.ts#:~:text=AsyncPlugin) | 8.8.0 | + + + ## GIS | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| | maps | | [es_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch) | 8.1 | | maps | | [locators.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/locators.test.ts#:~:text=esFilters), [locators.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/locators.test.ts#:~:text=esFilters) | 8.1 | -| maps | | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter) | 8.1 | -| maps | | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter) | 8.1 | +| maps | | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter) | 8.1 | +| maps | | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter) | 8.1 | | maps | | [es_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=fetch) | 8.1 | -| maps | | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter) | 8.1 | +| maps | | [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [can_skip_fetch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/util/can_skip_fetch.test.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=Filter) | 8.1 | +| maps | | [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings) | 8.8.0 | +| maps | | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave), [render_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/render_app.d.ts#:~:text=onAppLeave), [map_page.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_page.d.ts#:~:text=onAppLeave), [map_app.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts#:~:text=onAppLeave) | 8.8.0 | +| maps | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | +| mapsEms | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=license%24) | 8.8.0 | +| mapsEms | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=refresh) | 8.8.0 | + + + +## Kibana Core + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| cloud | | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud/public/plugin.tsx#:~:text=environment) | 8.8.0 | +| kibanaOverview | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | 8.8.0 | +| savedObjectsTaggingOss | | [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject) | 8.8.0 | @@ -67,11 +102,73 @@ 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 | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 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 | +| dashboard | | [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings) | 8.8.0 | +| dashboard | | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [dashboard_router.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/dashboard_router.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave), [types.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/target/types/public/types.d.ts#:~:text=onAppLeave) | 8.8.0 | +| dashboard | | [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning) | 8.8.0 | +| 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 | + + + +## Kibana Telemetry + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| kibanaUsageCollection | | [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process) | 8.8.0 | + + + +## Logstash + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| logstash | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/logstash/public/plugin.ts#:~:text=license%24) | 8.8.0 | + + + +## Machine Learning UI + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| ml | | [check_license.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | +| ml | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 | +| ml | | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | 8.8.0 | +| ml | | [errors.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req), [errors.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req) | 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. | + + + +## Platform Security + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| spaces | | [on_post_auth_interceptor.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.ts#:~:text=getKibanaFeatures), [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=getKibanaFeatures), [on_post_auth_interceptor.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.test.ts#:~:text=getKibanaFeatures), [app_authorization.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 17 more | 8.8.0 | +| spaces | | [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 | +| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| security | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 + +This is relied on by the reporting feature, and should be removed once reporting +migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | +| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| security | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 + +This is relied on by the reporting feature, and should be removed once reporting +migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | +| security | | [authorization_service.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 | +| security | | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | +| security | | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 | +| security | | [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | +| security | | [logout_app.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | +| security | | [logout_app.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 | @@ -79,12 +176,51 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| stackAlerts | | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [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=IFieldType), [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=IFieldType)+ 14 more | 8.2 | -| stackAlerts | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=esKuery) | 8.1 | -| stackAlerts | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=esQuery) | 8.1 | -| stackAlerts | | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [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=IFieldType), [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=IFieldType)+ 38 more | 8.2 | -| stackAlerts | | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx#:~:text=IFieldType), [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=IFieldType), [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=IFieldType)+ 14 more | 8.2 | -| alerting | | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode) | 8.1 | -| alerting | | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode) | 8.1 | -| alerting | | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=nodeBuilder), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=nodeBuilder), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder), [find_and_cleanup_tasks.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/cleanup_failed_executions/find_and_cleanup_tasks.ts#:~:text=nodeBuilder) | 8.1 | -| alerting | | [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode), [rules_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/rules_client/rules_client.ts#:~:text=KueryNode) | 8.1 | \ No newline at end of file +| stackAlerts | | [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType) | 8.2 | +| stackAlerts | | [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType) | 8.2 | +| stackAlerts | | [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType), [single_field_select.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts#:~:text=IFieldType) | 8.2 | +| 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 | + + + +## Security solution + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| 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), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 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), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 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 | +| securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler)+ 3 more | 8.8.0 | + + + +## Stack Management + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| upgradeAssistant | | [reindex_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/services/license.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/server/services/license.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/remote_clusters/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/rollup/server/services/license.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/snapshot_restore/server/services/license.ts#:~:text=license%24) | 8.8.0 | +| licenseManagement | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/license_management/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/public/plugin.ts#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 | + + + +## Stack Monitoring + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| monitoring | | [legacy_shims.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/legacy_shims.ts#:~:text=injectedMetadata) | 8.8.0 | +| monitoring | | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | + + + +## Vis Editors + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| lens | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/check_for_duplicate_title.d.ts#:~:text=SavedObject), [check_for_duplicate_title.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/check_for_duplicate_title.d.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.d.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.d.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.d.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject)+ 2 more | 8.8.0 | +| lens | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave), [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave), [app.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/visualize_app/app.d.ts#:~:text=onAppLeave), [index.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/visualize_app/index.d.ts#:~:text=onAppLeave), [visualize_editor_common.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/target/types/public/visualize_app/components/visualize_editor_common.d.ts#:~:text=onAppLeave)+ 1 more | 8.8.0 | +| lens | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning), [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | +| visualizations | | [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings), [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings) | 8.8.0 | +| management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath), [application.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/management/target/types/public/application.d.ts#:~:text=appBasePath) | 8.8.0 | +| visTypeVega | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | 8.8.0 | +| visTypeVega | | [search_api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.ts#:~:text=injectedMetadata), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata), [search_api.d.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/target/types/public/data_model/search_api.d.ts#:~:text=injectedMetadata) | 8.8.0 | \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index eee8b46fce45d1..fcec20c8c9ba26 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-03-15 +date: 2022-03-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 37bf36e2436990..4f5f940b632751 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -884,7 +884,7 @@ "label": "sharingSavedObjectProps", "description": [], "signature": [ - "{ outcome?: \"conflict\" | \"aliasMatch\" | \"exactMatch\" | undefined; aliasTargetId?: string | undefined; errorJSON?: string | undefined; } | undefined" + "{ outcome?: \"exactMatch\" | \"aliasMatch\" | \"conflict\" | undefined; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; errorJSON?: string | undefined; } | undefined" ], "path": "src/plugins/discover/public/services/saved_searches/types.ts", "deprecated": false diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 369c5b190c11d2..e09a657d79b330 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 80651eb7cc7cc1..c22a1a2bbca204 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-03-15 +date: 2022-03-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 2d28734152a8c0..4620947c33e954 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-03-15 +date: 2022-03-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/elastic_datemath.mdx b/api_docs/elastic_datemath.mdx index aba803d48c7959..b4776e2692e2d0 100644 --- a/api_docs/elastic_datemath.mdx +++ b/api_docs/elastic_datemath.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-datemath title: "@elastic/datemath" image: https://source.unsplash.com/400x175/?github summary: API docs for the @elastic/datemath plugin -date: 2022-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/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/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index 612ce94547c240..f6bbd0035ca403 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -1008,7 +1008,13 @@ "label": "settings", "description": [], "signature": [ - "EmbeddableContainerSettings", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableContainerSettings", + "text": "EmbeddableContainerSettings" + }, " | undefined" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", @@ -6023,6 +6029,49 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableContainerSettings", + "type": "Interface", + "tags": [], + "label": "EmbeddableContainerSettings", + "description": [], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableContainerSettings.initializeSequentially", + "type": "CompoundType", + "tags": [], + "label": "initializeSequentially", + "description": [ + "\nIf true, the container will wait for each embeddable to load after creation before loading the next embeddable." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableContainerSettings.childIdInitializeOrder", + "type": "Array", + "tags": [], + "label": "childIdInitializeOrder", + "description": [ + "\nInitialise children in the order specified. If an ID does not match it will be skipped and if a child is not included it will be initialized in the default order after the list of provided IDs." + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableContext", diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 931f0b5966e844..624934540cabb9 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 471 | 0 | 384 | 5 | +| 474 | 0 | 385 | 4 | ## Client diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 182867976fb2ac..bb6a0292ce7684 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-03-15 +date: 2022-03-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.mdx b/api_docs/encrypted_saved_objects.mdx index b813fc580f5ca3..8b4e95d4a1a288 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-03-15 +date: 2022-03-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.mdx b/api_docs/enterprise_search.mdx index cb4a1b99de4871..fafa78ee311f43 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/es_ui_shared.devdocs.json b/api_docs/es_ui_shared.devdocs.json index 3a1d9cad050103..16fd42fccb9483 100644 --- a/api_docs/es_ui_shared.devdocs.json +++ b/api_docs/es_ui_shared.devdocs.json @@ -700,6 +700,37 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "esUiShared", + "id": "def-public.ViewApiRequestFlyout", + "type": "Function", + "tags": [], + "label": "ViewApiRequestFlyout", + "description": [], + "signature": [ + "(props: ViewApiRequestFlyoutProps) => JSX.Element" + ], + "path": "src/plugins/es_ui_shared/public/components/view_api_request_flyout/view_api_request_flyout.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-public.ViewApiRequestFlyout.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "ViewApiRequestFlyoutProps" + ], + "path": "src/plugins/es_ui_shared/public/components/view_api_request_flyout/view_api_request_flyout.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "esUiShared", "id": "def-public.WithPrivileges", diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 4edf8313013864..ad34313432e518 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-ma | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 110 | 3 | 106 | 3 | +| 112 | 3 | 108 | 3 | ## Client diff --git a/api_docs/event_annotation.devdocs.json b/api_docs/event_annotation.devdocs.json new file mode 100644 index 00000000000000..681635d96de866 --- /dev/null +++ b/api_docs/event_annotation.devdocs.json @@ -0,0 +1,709 @@ +{ + "id": "eventAnnotation", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-public.EventAnnotationServiceType", + "type": "Interface", + "tags": [], + "label": "EventAnnotationServiceType", + "description": [], + "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-public.EventAnnotationServiceType.toExpression", + "type": "Function", + "tags": [], + "label": "toExpression", + "description": [], + "signature": [ + "(props: ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.EventAnnotationArgs", + "text": "EventAnnotationArgs" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-public.EventAnnotationServiceType.toExpression.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.EventAnnotationArgs", + "text": "EventAnnotationArgs" + } + ], + "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-public.defaultAnnotationColor", + "type": "string", + "tags": [], + "label": "defaultAnnotationColor", + "description": [], + "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "parentPluginId": "eventAnnotation", + "id": "def-public.EventAnnotationService", + "type": "Class", + "tags": [], + "label": "EventAnnotationService", + "description": [], + "path": "src/plugins/event_annotation/public/event_annotation_service/index.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-public.EventAnnotationService.getService", + "type": "Function", + "tags": [], + "label": "getService", + "description": [], + "signature": [ + "() => Promise<", + { + "pluginId": "eventAnnotation", + "scope": "public", + "docId": "kibEventAnnotationPluginApi", + "section": "def-public.EventAnnotationServiceType", + "text": "EventAnnotationServiceType" + }, + ">" + ], + "path": "src/plugins/event_annotation/public/event_annotation_service/index.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.eventAnnotationGroup", + "type": "Function", + "tags": [], + "label": "eventAnnotationGroup", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"event_annotation_group\", null, ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.EventAnnotationGroupArgs", + "text": "EventAnnotationGroupArgs" + }, + ", ", + "EventAnnotationGroupOutput", + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableRecord", + ">>" + ], + "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.EventAnnotationGroupArgs", + "type": "Interface", + "tags": [], + "label": "EventAnnotationGroupArgs", + "description": [], + "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.EventAnnotationGroupArgs.annotations", + "type": "Array", + "tags": [], + "label": "annotations", + "description": [], + "signature": [ + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.EventAnnotationOutput", + "text": "EventAnnotationOutput" + }, + "[]" + ], + "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.EventAnnotationArgs", + "type": "Type", + "tags": [], + "label": "EventAnnotationArgs", + "description": [], + "signature": [ + "{ time: string; } & ", + "StyleProps" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.EventAnnotationConfig", + "type": "Type", + "tags": [], + "label": "EventAnnotationConfig", + "description": [], + "signature": [ + "{ id: string; key: { type: \"point_in_time\"; timestamp: string; }; } & ", + "StyleProps" + ], + "path": "src/plugins/event_annotation/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.EventAnnotationOutput", + "type": "Type", + "tags": [], + "label": "EventAnnotationOutput", + "description": [], + "signature": [ + "{ time: string; } & ", + "StyleProps", + " & { type: \"manual_event_annotation\"; }" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation", + "type": "Object", + "tags": [], + "label": "manualEventAnnotation", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "\"manual_event_annotation\"" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.aliases", + "type": "Array", + "tags": [], + "label": "aliases", + "description": [], + "signature": [ + "never[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"manual_event_annotation\"" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.inputTypes", + "type": "Array", + "tags": [], + "label": "inputTypes", + "description": [], + "signature": [ + "\"null\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args", + "type": "Object", + "tags": [], + "label": "args", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.time", + "type": "Object", + "tags": [], + "label": "time", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.time.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.time.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.label", + "type": "Object", + "tags": [], + "label": "label", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.label.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.label.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.color", + "type": "Object", + "tags": [], + "label": "color", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.color.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.color.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.lineStyle", + "type": "Object", + "tags": [], + "label": "lineStyle", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.lineStyle.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.lineStyle.options", + "type": "Array", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "(\"solid\" | \"dashed\" | \"dotted\")[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.lineStyle.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.lineWidth", + "type": "Object", + "tags": [], + "label": "lineWidth", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.lineWidth.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"number\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.lineWidth.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.icon", + "type": "Object", + "tags": [], + "label": "icon", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.icon.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.icon.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.textVisibility", + "type": "Object", + "tags": [], + "label": "textVisibility", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.textVisibility.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"boolean\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.textVisibility.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.isHidden", + "type": "Object", + "tags": [], + "label": "isHidden", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.isHidden.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"boolean\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.args.isHidden.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.fn", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(input: unknown, args: ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.EventAnnotationArgs", + "text": "EventAnnotationArgs" + }, + ") => { time: string; label: string; color?: string | undefined; icon?: string | undefined; lineWidth?: number | undefined; lineStyle?: ", + "LineStyle", + " | undefined; textVisibility?: boolean | undefined; isHidden?: boolean | undefined; type: \"manual_event_annotation\"; }" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.fn.$1", + "type": "Unknown", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualEventAnnotation.fn.$2", + "type": "CompoundType", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "{ time: string; } & ", + "StyleProps" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx new file mode 100644 index 00000000000000..e980e894ec9c8d --- /dev/null +++ b/api_docs/event_annotation.mdx @@ -0,0 +1,47 @@ +--- +id: kibEventAnnotationPluginApi +slug: /kibana-dev-docs/api/eventAnnotation +title: "eventAnnotation" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the eventAnnotation plugin +date: 2022-03-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. +--- +import eventAnnotationObj from './event_annotation.devdocs.json'; + +The Event Annotation service contains expressions for event annotations + +Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 49 | 0 | 49 | 3 | + +## Client + +### Start + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index 6b29890edb5ad3..5bed6025a0b480 100644 --- a/api_docs/event_log.devdocs.json +++ b/api_docs/event_log.devdocs.json @@ -1047,7 +1047,7 @@ "label": "data", "description": [], "signature": [ - "(Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; dataset?: string | undefined; severity?: number | undefined; created?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" + "(Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; dataset?: string | undefined; severity?: number | undefined; created?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" ], "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "deprecated": false @@ -1066,7 +1066,7 @@ "label": "IEvent", "description": [], "signature": [ - "DeepPartial | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; dataset?: string | undefined; severity?: number | undefined; created?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" + "DeepPartial | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; dataset?: string | undefined; severity?: number | undefined; created?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, @@ -1080,7 +1080,7 @@ "label": "IValidatedEvent", "description": [], "signature": [ - "Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; dataset?: string | undefined; severity?: number | undefined; created?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" + "Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; dataset?: string | undefined; severity?: number | undefined; created?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index caa7e2bf068b80..ac70e7c4b98ea2 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-03-15 +date: 2022-03-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 c41a1112ad8682..6698e7e0748a58 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-03-15 +date: 2022-03-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 48f91bc43d724c..ffa8059222d857 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/expression_heatmap.devdocs.json index f8ec7c01c72ab1..fa4e095495ed66 100644 --- a/api_docs/expression_heatmap.devdocs.json +++ b/api_docs/expression_heatmap.devdocs.json @@ -1569,6 +1569,19 @@ "description": [], "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "deprecated": false + }, + { + "parentPluginId": "expressionHeatmap", + "id": "def-common.heatmapLegendConfig.args.position.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [], + "signature": [ + "true" + ], + "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", + "deprecated": false } ] }, diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index 643d6e2c4c30ae..a179e30c2028c6 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-03-15 +date: 2022-03-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. --- @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 118 | 0 | 114 | 3 | +| 119 | 0 | 115 | 3 | ## Client diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index 954db0076b8118..c370278a9b1dc4 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-03-15 +date: 2022-03-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_metric.mdx b/api_docs/expression_metric.mdx index a8079a360284b9..e726fd7e4095ba 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-03-15 +date: 2022-03-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.mdx b/api_docs/expression_metric_vis.mdx index 84acf907e10a64..695ec7a869fbc8 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index deaa8982478da8..d19a7f17a29cca 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-03-15 +date: 2022-03-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 205d304740e191..f3e79c480bd66c 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-03-15 +date: 2022-03-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 a2ccaf9b28f40d..46a20f6dd4b4a0 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-03-15 +date: 2022-03-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 e5fc14d99910d4..8e959ae059b845 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-03-15 +date: 2022-03-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 8e8b938b633d94..f9c489faed9ea6 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-03-15 +date: 2022-03-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/expressions.devdocs.json b/api_docs/expressions.devdocs.json index 8d0cb94b734889..9749191d886024 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -1244,7 +1244,7 @@ "label": "getFunction", "description": [], "signature": [ - "(name: string) => ", + "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -1270,6 +1270,20 @@ "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.Executor.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -1282,7 +1296,7 @@ "label": "getFunctions", "description": [], "signature": [ - "() => Record Record ", + "(name: string, namespace: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -3934,6 +4005,20 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsService.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -3946,7 +4031,7 @@ "label": "getFunctions", "description": [], "signature": [ - "() => Record Record ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" - } + "(name: string) => ", + "ExpressionsServiceFork" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, @@ -4294,11 +4388,11 @@ "label": "name", "description": [], "signature": [ - "string | undefined" + "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] @@ -4898,6 +4992,19 @@ "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionType.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.help", @@ -5594,6 +5701,21 @@ ], "returnComment": [] }, + { + "parentPluginId": "expressions", + "id": "def-public.TablesAdapter.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "expressions", "id": "def-public.TablesAdapter.tables", @@ -6324,6 +6446,20 @@ "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.Datatable.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "DatatableMeta", + " | undefined" + ], + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.Datatable.rows", @@ -7539,6 +7675,19 @@ "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionFunctionDefinition.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.type", @@ -8314,6 +8463,19 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRenderDefinition.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.displayName", @@ -8521,7 +8683,7 @@ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], "signature": [ - "(name: string) => ", + "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -8547,6 +8709,20 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -8561,7 +8737,7 @@ "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." ], "signature": [ - "() => Record Record { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + "SavedObjectReference", + "[]; }" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.extract.$1", + "type": "CompoundType", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.inject", + "type": "Function", + "tags": [], + "label": "inject", + "description": [], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", references: ", + "SavedObjectReference", + "[]) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.inject.$1", + "type": "CompoundType", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.inject.$2", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.telemetry", + "type": "Function", + "tags": [], + "label": "telemetry", + "description": [], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData: Record) => Record" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.telemetry.$1", + "type": "CompoundType", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.telemetry.$2", + "type": "Object", + "tags": [], + "label": "telemetryData", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceStart.getAllMigrations", + "type": "Function", + "tags": [], + "label": "getAllMigrations", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.MigrateFunctionsObject", + "text": "MigrateFunctionsObject" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -8950,6 +9343,19 @@ "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionTypeDefinition.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.validate", @@ -10267,7 +10673,7 @@ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\" | \"null\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, @@ -11075,7 +11481,7 @@ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], "signature": [ - "(name: string) => ", + "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -11107,6 +11513,20 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceSetup.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -11123,7 +11543,7 @@ "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." ], "signature": [ - "() => Record Record ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" - } + "(namespace: string) => ", + "ExpressionsServiceFork" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, @@ -11224,16 +11653,14 @@ "id": "def-public.ExpressionsServiceSetup.fork.$1", "type": "string", "tags": [], - "label": "name", - "description": [ - "A fork name that can be used to get fork instance later." - ], + "label": "namespace", + "description": [], "signature": [ - "string | undefined" + "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] @@ -11422,6 +11849,28 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionsServiceSetup.getAllMigrations", + "type": "Function", + "tags": [], + "label": "getAllMigrations", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.MigrateFunctionsObject", + "text": "MigrateFunctionsObject" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "lifecycle": "setup", @@ -12699,7 +13148,7 @@ "label": "getFunction", "description": [], "signature": [ - "(name: string) => ", + "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -12725,6 +13174,20 @@ "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-server.Executor.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -12737,7 +13200,7 @@ "label": "getFunctions", "description": [], "signature": [ - "() => Record Record ", + "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -21106,6 +21692,20 @@ "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.Executor.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -21118,7 +21718,7 @@ "label": "getFunctions", "description": [], "signature": [ - "() => Record Record ", + "(name: string, namespace: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -23082,6 +23739,20 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsService.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -23094,7 +23765,7 @@ "label": "getFunctions", "description": [], "signature": [ - "() => Record Record ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" - } + "(name: string) => ", + "ExpressionsServiceFork" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, @@ -23442,11 +24122,11 @@ "label": "name", "description": [], "signature": [ - "string | undefined" + "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] @@ -24046,6 +24726,19 @@ "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionType.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.help", @@ -24742,6 +25435,21 @@ ], "returnComment": [] }, + { + "parentPluginId": "expressions", + "id": "def-common.TablesAdapter.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "expressions", "id": "def-common.TablesAdapter.tables", @@ -25747,11 +26455,9 @@ "type": "Function", "tags": [], "label": "getByAlias", - "description": [ - "\nThis is used for looking up function/argument definitions. It looks through\nthe given object/array for a case-insensitive match, which could be either the\n`name` itself, or something under the `aliases` property." - ], + "description": [], "signature": [ - "(node: T[] | Record, nodeName: string) => T | undefined" + "(node: T[] | Record, nodeName: string, nodeNamespace: string | undefined) => T | undefined" ], "path": "src/plugins/expressions/common/util/get_by_alias.ts", "deprecated": false, @@ -25783,6 +26489,20 @@ "path": "src/plugins/expressions/common/util/get_by_alias.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.getByAlias.$3", + "type": "string", + "tags": [], + "label": "nodeNamespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/util/get_by_alias.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [], @@ -26637,6 +27357,20 @@ "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.Datatable.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "DatatableMeta", + " | undefined" + ], + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.Datatable.rows", @@ -26734,7 +27468,7 @@ "label": "type", "description": [], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\" | \"null\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false @@ -28714,6 +29448,19 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionExecutionParams.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false } ], "initialIsOpen": false @@ -28786,6 +29533,19 @@ "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionFunctionDefinition.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.type", @@ -29561,6 +30321,19 @@ "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionRenderDefinition.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.displayName", @@ -29774,7 +30547,7 @@ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], "signature": [ - "(name: string) => ", + "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -29806,6 +30579,20 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceSetup.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -29822,7 +30609,7 @@ "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." ], "signature": [ - "() => Record Record ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" - } + "(namespace: string) => ", + "ExpressionsServiceFork" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, @@ -29923,16 +30719,14 @@ "id": "def-common.ExpressionsServiceSetup.fork.$1", "type": "string", "tags": [], - "label": "name", - "description": [ - "A fork name that can be used to get fork instance later." - ], + "label": "namespace", + "description": [], "signature": [ - "string | undefined" + "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] @@ -30121,6 +30915,28 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceSetup.getAllMigrations", + "type": "Function", + "tags": [], + "label": "getAllMigrations", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.MigrateFunctionsObject", + "text": "MigrateFunctionsObject" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -30147,7 +30963,7 @@ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], "signature": [ - "(name: string) => ", + "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", @@ -30173,6 +30989,20 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.getFunction.$2", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -30187,7 +31017,7 @@ "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." ], "signature": [ - "() => Record Record { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + "SavedObjectReference", + "[]; }" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.extract.$1", + "type": "CompoundType", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.inject", + "type": "Function", + "tags": [], + "label": "inject", + "description": [], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", references: ", + "SavedObjectReference", + "[]) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.inject.$1", + "type": "CompoundType", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.inject.$2", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.telemetry", + "type": "Function", + "tags": [], + "label": "telemetry", + "description": [], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData: Record) => Record" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.telemetry.$1", + "type": "CompoundType", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.telemetry.$2", + "type": "Object", + "tags": [], + "label": "telemetryData", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionsServiceStart.getAllMigrations", + "type": "Function", + "tags": [], + "label": "getAllMigrations", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.MigrateFunctionsObject", + "text": "MigrateFunctionsObject" + } + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -30576,6 +31623,19 @@ "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionTypeDefinition.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.validate", @@ -32071,7 +33131,7 @@ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\" | \"null\"" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\" | \"null\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, @@ -33306,6 +34366,14 @@ "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": true, "references": [ + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/target/types/public/functions/index.d.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/target/types/public/functions/index.d.ts" + }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/types/state.ts" @@ -33314,6 +34382,14 @@ "plugin": "canvas", "path": "x-pack/plugins/canvas/types/state.ts" }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/target/types/types/state.d.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/target/types/types/state.d.ts" + }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts" @@ -33354,6 +34430,14 @@ "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/table.ts" }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/target/types/canvas_plugin_src/functions/browser/markdown.d.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/target/types/canvas_plugin_src/functions/browser/markdown.d.ts" + }, { "plugin": "visTypeXy", "path": "src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts" @@ -34658,7 +35742,9 @@ "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, - "[]; }" + "[]; meta?: ", + "DatatableMeta", + " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, @@ -34710,7 +35796,9 @@ "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, - "[]; }" + "[]; meta?: ", + "DatatableMeta", + " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, @@ -36942,7 +38030,9 @@ "section": "def-common.DatatableRow", "text": "DatatableRow" }, - "[]; type: \"datatable\"; }>" + "[]; type: \"datatable\"; meta?: ", + "DatatableMeta", + " | undefined; }>" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index fc75339e0c3e32..9101e4139b50b7 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 2079 | 17 | 1632 | 4 | +| 2145 | 17 | 1701 | 6 | ## Client diff --git a/api_docs/features.devdocs.json b/api_docs/features.devdocs.json index 736522f08e8978..c0459cd78c0a66 100644 --- a/api_docs/features.devdocs.json +++ b/api_docs/features.devdocs.json @@ -316,6 +316,7 @@ ], "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "security", @@ -1463,6 +1464,7 @@ ], "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "deprecated": true, + "removeBy": "8.8.0\n\nThis is relied on by the reporting feature, and should be removed once reporting\nmigrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914", "references": [ { "plugin": "security", @@ -1548,6 +1550,7 @@ ], "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "security", @@ -2080,9 +2083,13 @@ "parentPluginId": "features", "id": "def-server.PluginSetupContract.getKibanaFeatures", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "getKibanaFeatures", - "description": [], + "description": [ + "\nCalling this function during setup will crash Kibana.\nUse start contract instead." + ], "signature": [ "() => ", { @@ -2095,7 +2102,122 @@ "[]" ], "path": "x-pack/plugins/features/server/plugin.ts", - "deprecated": false, + "deprecated": true, + "removeBy": "8.8.0", + "references": [ + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.ts" + }, + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/app_authorization.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/authorization_service.tsx" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/plugin.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/app_authorization.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/public/management/roles/__fixtures__/kibana_privileges.ts" + } + ], "children": [], "returnComment": [] }, @@ -2103,9 +2225,13 @@ "parentPluginId": "features", "id": "def-server.PluginSetupContract.getElasticsearchFeatures", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "getElasticsearchFeatures", - "description": [], + "description": [ + "\nCalling this function during setup will crash Kibana.\nUse start contract instead." + ], "signature": [ "() => ", { @@ -2118,7 +2244,14 @@ "[]" ], "path": "x-pack/plugins/features/server/plugin.ts", - "deprecated": false, + "deprecated": true, + "removeBy": "8.8.0", + "references": [ + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/authorization_service.tsx" + } + ], "children": [], "returnComment": [] }, @@ -2144,7 +2277,9 @@ "type": "Function", "tags": [], "label": "enableReportingUiCapabilities", - "description": [], + "description": [ + "\nIn the future, OSS features should register their own subfeature\nprivileges. This can be done when parts of Reporting are moved to\nsrc/plugins. For now, this method exists for `reporting` to tell\n`features` to include Reporting when registering OSS features." + ], "signature": [ "() => void" ], @@ -3029,6 +3164,7 @@ ], "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", "deprecated": true, + "removeBy": "8.8.0\n\nThis is relied on by the reporting feature, and should be removed once reporting\nmigrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914", "references": [ { "plugin": "security", @@ -3114,6 +3250,7 @@ ], "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "security", diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 099d00563c1a24..c7f90ce7dbdcf9 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-03-15 +date: 2022-03-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. --- @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 222 | 0 | 98 | 2 | +| 222 | 0 | 95 | 2 | ## Client diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 51d47a52bfccaf..002c4678ca62d3 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-03-15 +date: 2022-03-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 7e3a73da890714..ef5c437ae1ed8f 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-03-15 +date: 2022-03-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 26d8654660beaa..fa373cd16c7bb8 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -8897,74 +8897,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.storedPackagePoliciesToAgentInputs", - "type": "Function", - "tags": [], - "label": "storedPackagePoliciesToAgentInputs", - "description": [], - "signature": [ - "(packagePolicies: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - }, - "[], outputId?: string) => ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyInput", - "text": "FullAgentPolicyInput" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.storedPackagePoliciesToAgentInputs.$1", - "type": "Array", - "tags": [], - "label": "packagePolicies", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.storedPackagePoliciesToAgentInputs.$2", - "type": "string", - "tags": [], - "label": "outputId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.validatePackagePolicy", @@ -12424,6 +12356,65 @@ ], "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", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "{ agentsIds: string[]; }" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.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", + "tags": [], + "label": "items", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.IncomingDataList", + "text": "IncomingDataList" + }, + "[]" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.GetAgentPoliciesRequest", @@ -13594,6 +13585,32 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.IncomingDataList", + "type": "Interface", + "tags": [], + "label": "IncomingDataList", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/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.IndexTemplate", @@ -18041,6 +18058,27 @@ ], "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 @@ -18505,7 +18543,7 @@ "section": "def-common.ValueOf", "text": "ValueOf" }, - "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; updated_by: string; namespace: string; is_default?: boolean | undefined; is_default_fleet_server?: boolean | undefined; has_fleet_server?: boolean | undefined; is_managed: boolean; 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; package_policies: string[] | ", + "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; namespace: string; updated_at: string; updated_by: string; is_default?: boolean | undefined; is_default_fleet_server?: boolean | undefined; has_fleet_server?: boolean | undefined; is_managed: boolean; 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; package_policies: string[] | ", { "pluginId": "fleet", "scope": "common", @@ -19188,6 +19226,20 @@ "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", @@ -19936,6 +19988,14 @@ "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", @@ -19952,26 +20012,20 @@ "section": "def-common.KibanaAssetParts", "text": "KibanaAssetParts" }, + "[]; osquery_pack_asset: ", + { + "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.KUBERNETES_RUN_INSTRUCTIONS", - "type": "string", - "tags": [], - "label": "KUBERNETES_RUN_INSTRUCTIONS", - "description": [], - "signature": [ - "\"kubectl apply -f elastic-agent-standalone-kubernetes.yaml\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.LICENCE_FOR_PER_POLICY_OUTPUT", @@ -20359,7 +20413,7 @@ "section": "def-common.PackagePolicyPackage", "text": "PackagePolicyPackage" }, - " | undefined; description?: string | undefined; name: string; enabled: boolean; updated_at: string; created_at: string; created_by: string; updated_by: string; namespace: string; inputs: ", + " | undefined; description?: string | undefined; name: string; enabled: boolean; namespace: string; updated_at: string; created_at: string; created_by: string; updated_by: string; inputs: ", { "pluginId": "fleet", "scope": "common", @@ -20872,34 +20926,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.STANDALONE_RUN_INSTRUCTIONS_LINUXMAC", - "type": "string", - "tags": [], - "label": "STANDALONE_RUN_INSTRUCTIONS_LINUXMAC", - "description": [], - "signature": [ - "\"sudo ./elastic-agent install\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.STANDALONE_RUN_INSTRUCTIONS_WINDOWS", - "type": "string", - "tags": [], - "label": "STANDALONE_RUN_INSTRUCTIONS_WINDOWS", - "description": [], - "signature": [ - "\".\\\\elastic-agent.exe install\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.TemplateMap", @@ -21204,6 +21230,16 @@ "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", @@ -21803,6 +21839,21 @@ "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", @@ -22516,7 +22567,7 @@ "label": "getInfoPath", "description": [], "signature": [ - "(pkgName: string, pkgVersion: string) => string" + "(pkgName: string, pkgVersion?: string | undefined) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, @@ -22543,11 +22594,11 @@ "label": "pkgVersion", "description": [], "signature": [ - "string" + "string | undefined" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index f5aded9b08da51..1cb4779cf05ac5 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 1367 | 8 | 1250 | 9 | +| 1371 | 8 | 1254 | 9 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index bec26cfffe7fd0..460a8f1f99c7e2 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-03-15 +date: 2022-03-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 a54f1734092195..56a7ef14f9710e 100644 --- a/api_docs/home.devdocs.json +++ b/api_docs/home.devdocs.json @@ -1222,6 +1222,7 @@ ], "path": "src/plugins/home/public/plugin.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "cloud", diff --git a/api_docs/home.mdx b/api_docs/home.mdx index e873c4f033622c..e66141c5d0ea43 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-03-15 +date: 2022-03-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 2d8ae90d25ddff..735d7c86b1d77f 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-03-15 +date: 2022-03-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.mdx b/api_docs/index_management.mdx index 8049c990d9cde6..68d525f2967e57 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-03-15 +date: 2022-03-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.mdx b/api_docs/infra.mdx index d0e6bed7ddc21b..3c7d240b135bb0 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-03-15 +date: 2022-03-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 993c9417fc3674..67ef909de820a2 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-03-15 +date: 2022-03-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 99309a8be06403..7b6e04383eabcc 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-03-15 +date: 2022-03-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 4f2951d348d803..81eaf8db3ac71d 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-03-15 +date: 2022-03-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_alerts.mdx b/api_docs/kbn_alerts.mdx index cd5ca2617fda58..9c49f7f420cbaa 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-03-15 +date: 2022-03-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 ba6045fefb9c4e..196faa8fa3bd0a 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-03-15 +date: 2022-03-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_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 496fbc8578fdee..0249c5f880e94c 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-03-15 +date: 2022-03-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 703e9859cabaf0..0c7bcc25456e5f 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-03-15 +date: 2022-03-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_bazel_packages.devdocs.json b/api_docs/kbn_bazel_packages.devdocs.json index d55a84daa74b0a..babc54a49973c8 100644 --- a/api_docs/kbn_bazel_packages.devdocs.json +++ b/api_docs/kbn_bazel_packages.devdocs.json @@ -205,7 +205,24 @@ ], "interfaces": [], "enums": [], - "misc": [], + "misc": [ + { + "parentPluginId": "@kbn/bazel-packages", + "id": "def-server.BAZEL_PACKAGE_DIRS", + "type": "Array", + "tags": [], + "label": "BAZEL_PACKAGE_DIRS", + "description": [ + "\nThis is a list of repo-relative paths to directories containing packages. Do not\ninclude `**` in these, one or two `*` segments is acceptable, we need this search\nto be super fast so please avoid deep recursive searching.\n\n eg. src/vis-editors => would find a package at src/vis-editors/foo/package.json\n src/vis-editors/* => would find a package at src/vis-editors/foo/bar/package.json" + ], + "signature": [ + "string[]" + ], + "path": "packages/kbn-bazel-packages/src/bazel_package_dirs.ts", + "deprecated": false, + "initialIsOpen": false + } + ], "objects": [] }, "common": { diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index 6bf92a041cf713..b52570b5e5d7f4 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 11 | 0 | 5 | 1 | +| 12 | 0 | 5 | 1 | ## Server @@ -28,3 +28,6 @@ Contact [Owner missing] for questions regarding this plugin. ### Classes +### Consts, variables and types + + diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index 92c13f83f3af62..8e334c0d762c1a 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-03-15 +date: 2022-03-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_config.mdx b/api_docs/kbn_config.mdx index eeb26751447731..a5af39a8a08727 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-03-15 +date: 2022-03-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_schema.mdx b/api_docs/kbn_config_schema.mdx index 1cb53128a84f63..a7df7613cc2f5a 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-03-15 +date: 2022-03-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_crypto.mdx b/api_docs/kbn_crypto.mdx index 9a25ed1ad7edef..e48252de8fb607 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-03-15 +date: 2022-03-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_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 9964ddb0344df3..714481f98e1f5f 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-03-15 +date: 2022-03-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 d1ca28c9197529..7dc816e6d0513f 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -144,7 +144,7 @@ "label": "apm", "description": [], "signature": [ - "{ readonly kibanaSettings: string; readonly supportedServiceMaps: string; readonly customLinks: string; readonly droppedTransactionSpans: string; readonly upgrading: string; readonly metaData: string; }" + "{ readonly kibanaSettings: string; readonly supportedServiceMaps: string; readonly customLinks: string; readonly droppedTransactionSpans: string; readonly upgrading: string; readonly metaData: string; readonly overview: string; readonly tailSamplingPolicies: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -274,7 +274,7 @@ "label": "enterpriseSearch", "description": [], "signature": [ - "{ readonly configuration: string; readonly licenseManagement: string; readonly mailService: string; readonly usersAccess: string; }" + "{ readonly configuration: string; readonly licenseManagement: string; readonly mailService: string; readonly troubleshootSetup: string; readonly usersAccess: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -287,7 +287,7 @@ "label": "workplaceSearch", "description": [], "signature": [ - "{ readonly apiKeys: string; readonly box: string; readonly confluenceCloud: string; readonly confluenceServer: string; readonly customSources: string; readonly customSourcePermissions: string; readonly documentPermissions: string; readonly dropbox: string; readonly externalIdentities: string; readonly gitHub: string; readonly gettingStarted: string; readonly gmail: string; readonly googleDrive: string; readonly indexingSchedule: string; readonly jiraCloud: string; readonly jiraServer: string; readonly oneDrive: string; readonly permissions: string; readonly salesforce: string; readonly security: string; readonly serviceNow: string; readonly sharePoint: string; readonly slack: string; readonly synch: string; readonly zendesk: string; }" + "{ readonly apiKeys: string; readonly box: string; readonly confluenceCloud: string; readonly confluenceServer: string; readonly customSources: string; readonly customSourcePermissions: string; readonly documentPermissions: string; readonly dropbox: string; readonly externalSharePointOnline: string; readonly externalIdentities: string; readonly gitHub: string; readonly gettingStarted: string; readonly gmail: string; readonly googleDrive: string; readonly indexingSchedule: string; readonly jiraCloud: string; readonly jiraServer: string; readonly oneDrive: string; readonly permissions: string; readonly salesforce: string; readonly security: string; readonly serviceNow: string; readonly sharePoint: string; readonly sharePointServer: string; readonly slack: string; readonly synch: string; readonly zendesk: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -606,7 +606,7 @@ "label": "observability", "description": [], "signature": [ - "{ readonly guide: string; readonly infrastructureThreshold: string; readonly logsThreshold: string; readonly metricsThreshold: string; readonly monitorStatus: string; readonly monitorUptime: string; readonly tlsCertificate: string; readonly uptimeDurationAnomaly: string; }" + "{ readonly guide: string; readonly infrastructureThreshold: string; readonly logsThreshold: string; readonly metricsThreshold: string; readonly monitorStatus: string; readonly monitorUptime: string; readonly tlsCertificate: string; readonly uptimeDurationAnomaly: string; readonly monitorLogs: string; readonly analyzeMetrics: string; readonly monitorUptimeSynthetics: string; readonly userExperience: string; readonly createAlerts: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -792,6 +792,19 @@ ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/doc-links", + "id": "def-server.DocLinks.legal", + "type": "Object", + "tags": [], + "label": "legal", + "description": [], + "signature": [ + "{ readonly privacyStatement: string; }" + ], + "path": "packages/kbn-doc-links/src/types.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 5e3147e18f993e..5ce426161bc6ab 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 62 | 0 | 62 | 2 | +| 63 | 0 | 63 | 2 | ## Server diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 224ada7d252fc4..fea82120434780 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-03-15 +date: 2022-03-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 ab6e2616383c41..c5e9759b2102ae 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-03-15 +date: 2022-03-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_query.devdocs.json b/api_docs/kbn_es_query.devdocs.json index eac92f395ff74a..33838776782494 100644 --- a/api_docs/kbn_es_query.devdocs.json +++ b/api_docs/kbn_es_query.devdocs.json @@ -1663,6 +1663,38 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.escapeKuery", + "type": "Function", + "tags": [], + "label": "escapeKuery", + "description": [ + "\nEscapes a Kuery node value to ensure that special characters, operators, and whitespace do not result in a parsing error or unintended\nbehavior when using the value as an argument for the `buildNode` function." + ], + "signature": [ + "(str: string) => string" + ], + "path": "packages/kbn-es-query/src/kuery/utils/escape_kuery.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.escapeKuery.$1", + "type": "Uncategorized", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "A" + ], + "path": "node_modules/@types/lodash/ts3.1/common/util.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.fromKueryExpression", @@ -3885,14 +3917,6 @@ "text": "ExistsFilter" }, " | ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.MatchAllFilter", - "text": "MatchAllFilter" - }, - " | ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -3915,6 +3939,14 @@ "docId": "kibKbnEsQueryPluginApi", "section": "def-common.RangeFilter", "text": "RangeFilter" + }, + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.MatchAllFilter", + "text": "MatchAllFilter" } ], "path": "packages/kbn-es-query/src/filters/build_filters/types.ts", diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 40ac4a99797a99..1f320394b82ecd 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 211 | 1 | 159 | 11 | +| 213 | 1 | 159 | 11 | ## Common diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 7c9752cc3b155e..a3ab0aa04405df 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-03-15 +date: 2022-03-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_generate.mdx b/api_docs/kbn_generate.mdx index 05e1805262f1e5..a52a057fb88184 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-03-15 +date: 2022-03-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_i18n.mdx b/api_docs/kbn_i18n.mdx index c018ebb9f95ab6..31dd855bb20b03 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-03-15 +date: 2022-03-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_interpreter.mdx b/api_docs/kbn_interpreter.mdx index cb705c79bd28d8..6eb04eb6b44dbf 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-03-15 +date: 2022-03-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 6491602316c632..92cfaddd7425cf 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-03-15 +date: 2022-03-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_logging.mdx b/api_docs/kbn_logging.mdx index 1b6b8212af7fe3..fe1fc4865c53d6 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index 6d4dcb7aca7839..47feddb9ee96e4 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-03-15 +date: 2022-03-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.mdx b/api_docs/kbn_mapbox_gl.mdx index 0c458eabb1c9a3..f30d5b3005c9f5 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index c2a68dd755361f..131e0dca0813a3 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-03-15 +date: 2022-03-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 354283a4a4639f..aea6c086a5d321 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-03-15 +date: 2022-03-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_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index fb8d5a0d1f7c5f..722c46b010fa30 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-03-15 +date: 2022-03-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 126fef811d46c5..9c8b329b18bb80 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-03-15 +date: 2022-03-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_pm.mdx b/api_docs/kbn_pm.mdx index bcd856831bc109..c2bcf85b204835 100644 --- a/api_docs/kbn_pm.mdx +++ b/api_docs/kbn_pm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-pm title: "@kbn/pm" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/pm plugin -date: 2022-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/pm'] warning: This document is auto-generated and 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 b3bd0d109f59dd..267c495badc044 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-03-15 +date: 2022-03-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_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index e81dcfabacb3fc..fbfbfa631b4b2f 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-03-15 +date: 2022-03-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_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index ce3960c8fd011d..448c389482300f 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-03-15 +date: 2022-03-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.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 0df1e12c36d1e4..f22924e2220f8d 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 5c23a621d03792..5635ccfc7132ca 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-03-15 +date: 2022-03-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 0bdb0cb846908e..9381b63fd7ca49 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json index 944c66acef02eb..512f130f72ef4b 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json +++ b/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json @@ -1625,31 +1625,14 @@ }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.UseExceptionListsProps.showTrustedApps", - "type": "boolean", - "tags": [], - "label": "showTrustedApps", - "description": [], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.UseExceptionListsProps.showEventFilters", - "type": "boolean", - "tags": [], - "label": "showEventFilters", - "description": [], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.UseExceptionListsProps.showHostIsolationExceptions", - "type": "boolean", + "id": "def-common.UseExceptionListsProps.hideLists", + "type": "Object", "tags": [], - "label": "showHostIsolationExceptions", + "label": "hideLists", "description": [], + "signature": [ + "readonly string[] | undefined" + ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false } diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index ee1e10b57abbfe..f33e0b3da3ca4e 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 460 | 1 | 448 | 0 | +| 458 | 1 | 446 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 13a458eed52390..9d2d7372004c53 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 406013a5b1ce8f..da8ec9ab69e359 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-03-15 +date: 2022-03-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 4aba5e62963cbd..0516c6a5db34db 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-03-15 +date: 2022-03-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 e3acd1c60b1231..1b6ba111ea8ce5 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/kbn_securitysolution_list_hooks.devdocs.json index 56a6c1616eb21c..588e4a302b4e61 100644 --- a/api_docs/kbn_securitysolution_list_hooks.devdocs.json +++ b/api_docs/kbn_securitysolution_list_hooks.devdocs.json @@ -377,7 +377,7 @@ "\nHook for fetching ExceptionLists\n" ], "signature": [ - "({ errorMessage, http, initialPagination, filterOptions, namespaceTypes, notifications, showTrustedApps, showEventFilters, showHostIsolationExceptions, }: ", + "({ errorMessage, http, initialPagination, filterOptions, namespaceTypes, notifications, hideLists, }: ", "UseExceptionListsProps", ") => ", { @@ -396,7 +396,7 @@ "id": "def-common.useExceptionLists.$1", "type": "Object", "tags": [], - "label": "{\n errorMessage,\n http,\n initialPagination = DEFAULT_PAGINATION,\n filterOptions = {},\n namespaceTypes,\n notifications,\n showTrustedApps = false,\n showEventFilters = false,\n showHostIsolationExceptions = false,\n}", + "label": "{\n errorMessage,\n http,\n initialPagination = DEFAULT_PAGINATION,\n filterOptions = {},\n namespaceTypes,\n notifications,\n hideLists = [],\n}", "description": [], "signature": [ "UseExceptionListsProps" diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index 1b6d1163b15240..8c57af3b5a867a 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/kbn_securitysolution_list_utils.devdocs.json index 1b91981be43f3f..a5fa0a4c4b648a 100644 --- a/api_docs/kbn_securitysolution_list_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_list_utils.devdocs.json @@ -1717,7 +1717,7 @@ "label": "getFilters", "description": [], "signature": [ - "({ filters, namespaceTypes, showTrustedApps, showEventFilters, showHostIsolationExceptions, }: ", + "({ filters, namespaceTypes, hideLists }: ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", @@ -1735,7 +1735,7 @@ "id": "def-common.getFilters.$1", "type": "Object", "tags": [], - "label": "{\n filters,\n namespaceTypes,\n showTrustedApps,\n showEventFilters,\n showHostIsolationExceptions,\n}", + "label": "{ filters, namespaceTypes, hideLists }", "description": [], "signature": [ { @@ -2424,66 +2424,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.getTrustedAppsFilter", - "type": "Function", - "tags": [], - "label": "getTrustedAppsFilter", - "description": [], - "signature": [ - "(showTrustedApps: boolean, namespaceTypes: ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.SavedObjectType", - "text": "SavedObjectType" - }, - "[]) => string" - ], - "path": "packages/kbn-securitysolution-list-utils/src/get_trusted_apps_filter/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.getTrustedAppsFilter.$1", - "type": "boolean", - "tags": [], - "label": "showTrustedApps", - "description": [], - "signature": [ - "boolean" - ], - "path": "packages/kbn-securitysolution-list-utils/src/get_trusted_apps_filter/index.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.getTrustedAppsFilter.$2", - "type": "Array", - "tags": [], - "label": "namespaceTypes", - "description": [], - "signature": [ - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.SavedObjectType", - "text": "SavedObjectType" - }, - "[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/get_trusted_apps_filter/index.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/securitysolution-list-utils", "id": "def-common.getUpdatedEntriesOnDelete", @@ -3107,31 +3047,14 @@ }, { "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.GetFiltersParams.showTrustedApps", - "type": "boolean", - "tags": [], - "label": "showTrustedApps", - "description": [], - "path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.GetFiltersParams.showEventFilters", - "type": "boolean", - "tags": [], - "label": "showEventFilters", - "description": [], - "path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.GetFiltersParams.showHostIsolationExceptions", - "type": "boolean", + "id": "def-common.GetFiltersParams.hideLists", + "type": "Object", "tags": [], - "label": "showHostIsolationExceptions", + "label": "hideLists", "description": [], + "signature": [ + "readonly string[]" + ], "path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts", "deprecated": false } diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index b048021bb5fa13..17c04cc6a5a639 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 231 | 0 | 183 | 0 | +| 226 | 0 | 178 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 22364ff1ce723d..c39b406357f737 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-03-15 +date: 2022-03-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 6568f71dafd4c0..93b4fab165f4f8 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/kbn_securitysolution_utils.devdocs.json index 477e2877d75280..b312c9d9d3ca91 100644 --- a/api_docs/kbn_securitysolution_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_utils.devdocs.json @@ -63,10 +63,10 @@ "pluginId": "@kbn/securitysolution-utils", "scope": "server", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.TrustedAppEntryTypes", - "text": "TrustedAppEntryTypes" + "section": "def-server.EntryTypes", + "text": "EntryTypes" }, - "; value: string; }) => boolean" + "; value: string; }) => boolean | undefined" ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false, @@ -108,7 +108,7 @@ "label": "type", "description": [], "signature": [ - "\"match\" | \"wildcard\"" + "\"match\" | \"wildcard\" | \"match_any\"" ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false @@ -150,16 +150,16 @@ "pluginId": "@kbn/securitysolution-utils", "scope": "server", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.ConditionEntryField", - "text": "ConditionEntryField" + "section": "def-server.AllConditionEntryFields", + "text": "AllConditionEntryFields" }, "; type: ", { "pluginId": "@kbn/securitysolution-utils", "scope": "server", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.TrustedAppEntryTypes", - "text": "TrustedAppEntryTypes" + "section": "def-server.EntryTypes", + "text": "EntryTypes" }, "; value: string; }) => boolean" ], @@ -208,8 +208,8 @@ "pluginId": "@kbn/securitysolution-utils", "scope": "server", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.ConditionEntryField", - "text": "ConditionEntryField" + "section": "def-server.AllConditionEntryFields", + "text": "AllConditionEntryFields" } ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", @@ -223,7 +223,7 @@ "label": "type", "description": [], "signature": [ - "\"match\" | \"wildcard\"" + "\"match\" | \"wildcard\" | \"match_any\"" ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false @@ -393,6 +393,17 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-utils", + "id": "def-server.EntryFieldType", + "type": "Enum", + "tags": [], + "label": "EntryFieldType", + "description": [], + "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-utils", "id": "def-server.OperatingSystem", @@ -408,51 +419,91 @@ "misc": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.FILENAME_WILDCARD_WARNING", - "type": "string", + "id": "def-server.AllConditionEntryFields", + "type": "Type", "tags": [], - "label": "FILENAME_WILDCARD_WARNING", + "label": "AllConditionEntryFields", "description": [], + "signature": [ + { + "pluginId": "@kbn/securitysolution-utils", + "scope": "server", + "docId": "kibKbnSecuritysolutionUtilsPluginApi", + "section": "def-server.TrustedAppConditionEntryField", + "text": "TrustedAppConditionEntryField" + }, + " | ", + { + "pluginId": "@kbn/securitysolution-utils", + "scope": "server", + "docId": "kibKbnSecuritysolutionUtilsPluginApi", + "section": "def-server.BlocklistConditionEntryField", + "text": "BlocklistConditionEntryField" + } + ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.FILEPATH_WARNING", - "type": "string", + "id": "def-server.BlocklistConditionEntryField", + "type": "Type", "tags": [], - "label": "FILEPATH_WARNING", + "label": "BlocklistConditionEntryField", "description": [], + "signature": [ + "\"file.path\" | \"file.hash.*\" | \"file.Ext.code_signature\"" + ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.TrustedAppEntryTypes", + "id": "def-server.EntryTypes", "type": "Type", "tags": [], - "label": "TrustedAppEntryTypes", + "label": "EntryTypes", "description": [], "signature": [ - "\"match\" | \"wildcard\"" + "\"match\" | \"wildcard\" | \"match_any\"" ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false, "initialIsOpen": false - } - ], - "objects": [ + }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.UNIX_EXEC_PATH", - "type": "Object", + "id": "def-server.FILENAME_WILDCARD_WARNING", + "type": "string", "tags": [], - "label": "UNIX_EXEC_PATH", + "label": "FILENAME_WILDCARD_WARNING", + "description": [], + "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-utils", + "id": "def-server.FILEPATH_WARNING", + "type": "string", + "tags": [], + "label": "FILEPATH_WARNING", + "description": [], + "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-utils", + "id": "def-server.TrustedAppConditionEntryField", + "type": "Type", + "tags": [], + "label": "TrustedAppConditionEntryField", "description": [], "signature": [ - "RegExp" + "\"process.hash.*\" | \"process.executable.caseless\" | \"process.Ext.code_signature\"" ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false, @@ -460,19 +511,20 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.WIN_EXEC_PATH", - "type": "Object", + "id": "def-server.TrustedAppEntryTypes", + "type": "Type", "tags": [], - "label": "WIN_EXEC_PATH", + "label": "TrustedAppEntryTypes", "description": [], "signature": [ - "RegExp" + "\"match\" | \"wildcard\"" ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false, "initialIsOpen": false } - ] + ], + "objects": [] }, "common": { "classes": [], diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index 2514f8a9eec34c..6ca1d3b071818d 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-03-15 +date: 2022-03-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. --- @@ -18,13 +18,10 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 28 | 0 | 26 | 0 | +| 31 | 0 | 29 | 0 | ## Server -### Objects - - ### Functions diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index 7beff881ac4cbf..1ab1301c4d1cbb 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-03-15 +date: 2022-03-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 6a1ff8daa47708..d46b5bd6e4f1b6 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-03-15 +date: 2022-03-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_components.devdocs.json b/api_docs/kbn_shared_ux_components.devdocs.json new file mode 100644 index 00000000000000..dcccffd398f135 --- /dev/null +++ b/api_docs/kbn_shared_ux_components.devdocs.json @@ -0,0 +1,513 @@ +{ + "id": "@kbn/shared-ux-components", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.AddFromLibraryButton", + "type": "Function", + "tags": [], + "label": "AddFromLibraryButton", + "description": [], + "signature": [ + "({ onClick, ...rest }: ", + "Props", + ") => JSX.Element" + ], + "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.AddFromLibraryButton.$1", + "type": "Object", + "tags": [], + "label": "{ onClick, ...rest }", + "description": [], + "signature": [ + "Props" + ], + "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.ExitFullScreenButton", + "type": "Function", + "tags": [], + "label": "ExitFullScreenButton", + "description": [ + "\nA `ExitFullScreenButton` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LazyExitFullScreenButton` component lazily with\na predefined fallback and error boundary." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "Props", + " & React.RefAttributes<{}>>" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.ExitFullScreenButton.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.IconButtonGroup", + "type": "Function", + "tags": [], + "label": "IconButtonGroup", + "description": [ + "\nThe IconButtonGroup component that is wrapped by the `withSuspence` HOC." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "Props", + " & React.RefAttributes<{}>>" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.IconButtonGroup.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.KibanaSolutionAvatar", + "type": "Function", + "tags": [], + "label": "KibanaSolutionAvatar", + "description": [ + "\nA `KibanaSolutionAvatar` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `KibanaPageTemplateSolutionNavAvatarLazy` component lazily with\na predefined fallback and error boundary." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "KibanaSolutionAvatarProps", + " & React.RefAttributes<{}>>" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.KibanaSolutionAvatar.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.KibanaSolutionAvatarLazy", + "type": "Function", + "tags": [], + "label": "KibanaSolutionAvatarLazy", + "description": [ + "\nThe Lazily-loaded `KibanaSolutionAvatar` component. Consumers should use `React.Suspense` or\nthe withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent<", + "KibanaSolutionAvatarProps", + "> & { readonly _result: ({ className, size, ...rest }: ", + "KibanaSolutionAvatarProps", + ") => JSX.Element; }" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.KibanaSolutionAvatarLazy.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyExitFullScreenButton", + "type": "Function", + "tags": [], + "label": "LazyExitFullScreenButton", + "description": [ + "\nThe Lazily-loaded `ExitFullScreenButton` component. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent<", + "Props", + "> & { readonly _result: ({ onExit, toggleChrome }: ", + "Props", + ") => JSX.Element; }" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyExitFullScreenButton.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyIconButtonGroup", + "type": "Function", + "tags": [], + "label": "LazyIconButtonGroup", + "description": [ + "\nThe Lazily-loaded `IconButtonGroup` component. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent<", + "Props", + "> & { readonly _result: ({ buttons, legend }: ", + "Props", + ") => JSX.Element; }" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyIconButtonGroup.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyNoDataViews", + "type": "Function", + "tags": [], + "label": "LazyNoDataViews", + "description": [ + "\nThe Lazily-loaded `NoDataViews` component. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent<", + "Props", + "> & { readonly _result: ({ onDataViewCreated }: ", + "Props", + ") => JSX.Element; }" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyNoDataViews.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyNoDataViewsComponent", + "type": "Function", + "tags": [], + "label": "LazyNoDataViewsComponent", + "description": [ + "\nA pure `NoDataViews` component, with no services hooks. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent<", + "Props", + "> & { readonly _result: ({ onClickCreate, canCreateNewDataView, dataViewsDocLink, emptyPromptColor, }: ", + "Props", + ") => JSX.Element; }" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyNoDataViewsComponent.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyToolbarButton", + "type": "Function", + "tags": [], + "label": "LazyToolbarButton", + "description": [], + "signature": [ + "React.ExoticComponent<", + "Props", + "> & { readonly _result: ({ label, ...rest }: ", + "Props", + ") => JSX.Element; }" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.LazyToolbarButton.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.NoDataViews", + "type": "Function", + "tags": [], + "label": "NoDataViews", + "description": [ + "\nA `NoDataViews` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LazyNoDataViews` component lazily with\na predefined fallback and error boundary." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "Props", + " & React.RefAttributes<{}>>" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.NoDataViews.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.NoDataViewsComponent", + "type": "Function", + "tags": [], + "label": "NoDataViewsComponent", + "description": [ + "\nA pure `NoDataViews` component, with no services hooks. The component is wrapped by the `withSuspense` HOC.\nThis component can be used directly by consumers and will load the `LazyNoDataViewsComponent` lazily with\na predefined fallback and error boundary." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "Props", + " & React.RefAttributes<{}>>" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.NoDataViewsComponent.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.RedirectAppLinks", + "type": "Function", + "tags": [], + "label": "RedirectAppLinks", + "description": [], + "signature": [ + "React.ExoticComponent & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }> & { readonly _result: React.FC<", + "RedirectAppLinksProps", + ">; }" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.RedirectAppLinks.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.ToolbarButton", + "type": "Function", + "tags": [], + "label": "ToolbarButton", + "description": [ + "\nA `ToolbarButton` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LazyToolbarButton` component lazily with\na predefined fallback and error boundary." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "Props", + " & React.RefAttributes<{}>>" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.ToolbarButton.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx new file mode 100644 index 00000000000000..e471398dde3a17 --- /dev/null +++ b/api_docs/kbn_shared_ux_components.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnSharedUxComponentsPluginApi +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-03-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. +--- +import kbnSharedUxComponentsObj from './kbn_shared_ux_components.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 28 | 0 | 4 | 3 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_shared_ux_services.devdocs.json b/api_docs/kbn_shared_ux_services.devdocs.json new file mode 100644 index 00000000000000..08bfb4e4053c7c --- /dev/null +++ b/api_docs/kbn_shared_ux_services.devdocs.json @@ -0,0 +1,1311 @@ +{ + "id": "@kbn/shared-ux-services", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServicesFactory", + "type": "Function", + "tags": [], + "label": "mockServicesFactory", + "description": [ + "\nA factory function for creating a Jest-based implementation of `SharedUxServices`." + ], + "signature": [ + "() => { application: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxApplicationService", + "text": "SharedUxApplicationService" + }, + "; docLinks: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDocLinksService", + "text": "SharedUxDocLinksService" + }, + "; editors: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxEditorsService", + "text": "SharedUxEditorsService" + }, + "; http: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxHttpService", + "text": "SharedUxHttpService" + }, + "; permissions: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxUserPermissionsService", + "text": "SharedUxUserPermissionsService" + }, + "; platform: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxPlatformService", + "text": "SharedUxPlatformService" + }, + "; }" + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServicesProvider", + "type": "Function", + "tags": [], + "label": "SharedUxServicesProvider", + "description": [ + "\nThe `React.Context` Provider component for the `SharedUxServices` context. Any\nplugin or environment that consumes SharedUX components needs to wrap their React\ntree with this provider.\n\nWithin a plugin, you can use use the Shared UX plugin and retrieve a fully-configured\ncontext from the `start` contract." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxServices", + "text": "SharedUxServices" + }, + ">) => JSX.Element" + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServicesProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{ children, ...services }", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxServices", + "text": "SharedUxServices" + }, + ">" + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServicesFactory", + "type": "Function", + "tags": [], + "label": "stubServicesFactory", + "description": [ + "\nA factory function for creating simple stubbed implementations of all `SharedUxServices`." + ], + "signature": [ + "() => { application: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxApplicationService", + "text": "SharedUxApplicationService" + }, + "; docLinks: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDocLinksService", + "text": "SharedUxDocLinksService" + }, + "; editors: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxEditorsService", + "text": "SharedUxEditorsService" + }, + "; http: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxHttpService", + "text": "SharedUxHttpService" + }, + "; permissions: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxUserPermissionsService", + "text": "SharedUxUserPermissionsService" + }, + "; platform: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxPlatformService", + "text": "SharedUxPlatformService" + }, + "; }" + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.useApplication", + "type": "Function", + "tags": [], + "label": "useApplication", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxApplicationService", + "text": "SharedUxApplicationService" + } + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.useDocLinks", + "type": "Function", + "tags": [], + "label": "useDocLinks", + "description": [ + "\nReact hook for accessing the pre-wired `SharedUxDocLinksService`." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDocLinksService", + "text": "SharedUxDocLinksService" + } + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.useEditors", + "type": "Function", + "tags": [], + "label": "useEditors", + "description": [ + "\nReact hook for accessing the pre-wired `SharedUxEditorsService`." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxEditorsService", + "text": "SharedUxEditorsService" + } + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.useHttp", + "type": "Function", + "tags": [], + "label": "useHttp", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxHttpService", + "text": "SharedUxHttpService" + } + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.usePermissions", + "type": "Function", + "tags": [], + "label": "usePermissions", + "description": [ + "\nReact hook for accessing the pre-wired `SharedUxPermissionsService`." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxUserPermissionsService", + "text": "SharedUxUserPermissionsService" + } + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.usePlatformService", + "type": "Function", + "tags": [], + "label": "usePlatformService", + "description": [ + "\nReact hook for accessing the pre-wired `SharedUxPlatformService`." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxPlatformService", + "text": "SharedUxPlatformService" + } + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.useSharedUxServices", + "type": "Function", + "tags": [], + "label": "useSharedUxServices", + "description": [ + "\nReact hook for accessing pre-wired `SharedUxServices`." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxServices", + "text": "SharedUxServices" + } + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxApplicationService", + "type": "Interface", + "tags": [], + "label": "SharedUxApplicationService", + "description": [], + "path": "packages/kbn-shared-ux-services/src/services/application.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxApplicationService.navigateToUrl", + "type": "Function", + "tags": [], + "label": "navigateToUrl", + "description": [], + "signature": [ + "(url: string) => Promise" + ], + "path": "packages/kbn-shared-ux-services/src/services/application.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxApplicationService.navigateToUrl.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-shared-ux-services/src/services/application.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxApplicationService.currentAppId$", + "type": "Object", + "tags": [], + "label": "currentAppId$", + "description": [], + "signature": [ + "Observable", + "" + ], + "path": "packages/kbn-shared-ux-services/src/services/application.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxDocLinksService", + "type": "Interface", + "tags": [], + "label": "SharedUxDocLinksService", + "description": [ + "\nA service providing links to documentation about various features in Kibana." + ], + "path": "packages/kbn-shared-ux-services/src/services/doc_links.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxDocLinksService.dataViewsDocLink", + "type": "string", + "tags": [], + "label": "dataViewsDocLink", + "description": [ + "A link to information about Data Views in Kibana" + ], + "path": "packages/kbn-shared-ux-services/src/services/doc_links.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxEditorsService", + "type": "Interface", + "tags": [], + "label": "SharedUxEditorsService", + "description": [ + "\nA service providing methods to invoke and interact with various editors provided\nin Kibana." + ], + "path": "packages/kbn-shared-ux-services/src/services/editors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxEditorsService.openDataViewEditor", + "type": "Function", + "tags": [], + "label": "openDataViewEditor", + "description": [ + "A method to open the Data View Editor flow." + ], + "signature": [ + "(options: DataViewEditorOptions) => () => void" + ], + "path": "packages/kbn-shared-ux-services/src/services/editors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxEditorsService.openDataViewEditor.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "DataViewEditorOptions" + ], + "path": "packages/kbn-shared-ux-services/src/services/editors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxHttpService", + "type": "Interface", + "tags": [], + "label": "SharedUxHttpService", + "description": [], + "path": "packages/kbn-shared-ux-services/src/services/http.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxHttpService.addBasePath", + "type": "Function", + "tags": [], + "label": "addBasePath", + "description": [], + "signature": [ + "(url: string) => string" + ], + "path": "packages/kbn-shared-ux-services/src/services/http.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxHttpService.addBasePath.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-shared-ux-services/src/services/http.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxPlatformService", + "type": "Interface", + "tags": [], + "label": "SharedUxPlatformService", + "description": [ + "\nA service providing methods to interact with the platform in which this code is\nrunning, (almost always Kibana).\n\nRather than provide the entire `CoreStart` contract to components, we provide simplified\nabstractions around a use case specific to Shared UX. This way, we know exactly how the\n`CoreStart` and other plugins are used. This makes mocking and refactoring easier when\n upstream dependencies change." + ], + "path": "packages/kbn-shared-ux-services/src/services/platform.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxPlatformService.setIsFullscreen", + "type": "Function", + "tags": [], + "label": "setIsFullscreen", + "description": [ + "\nSets the fullscreen state of the chrome." + ], + "signature": [ + "(isFullscreen: boolean) => void" + ], + "path": "packages/kbn-shared-ux-services/src/services/platform.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxPlatformService.setIsFullscreen.$1", + "type": "boolean", + "tags": [], + "label": "isFullscreen", + "description": [ + "True if the chrome should be fullscreen, false otherwise." + ], + "signature": [ + "boolean" + ], + "path": "packages/kbn-shared-ux-services/src/services/platform.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServices", + "type": "Interface", + "tags": [], + "label": "SharedUxServices", + "description": [ + "\nA collection of services utilized by SharedUX. This serves as a thin\nabstraction layer between services provided by Kibana and other plugins\nwhile allowing this plugin to be developed independently of those contracts.\n\nIt also allows us to \"swap out\" differenct implementations of these services\nfor different environments, (e.g. Jest, Storybook, etc.)" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServices.application", + "type": "Object", + "tags": [], + "label": "application", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxApplicationService", + "text": "SharedUxApplicationService" + } + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServices.docLinks", + "type": "Object", + "tags": [], + "label": "docLinks", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDocLinksService", + "text": "SharedUxDocLinksService" + } + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServices.editors", + "type": "Object", + "tags": [], + "label": "editors", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxEditorsService", + "text": "SharedUxEditorsService" + } + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServices.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxHttpService", + "text": "SharedUxHttpService" + } + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServices.permissions", + "type": "Object", + "tags": [], + "label": "permissions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxUserPermissionsService", + "text": "SharedUxUserPermissionsService" + } + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServices.platform", + "type": "Object", + "tags": [], + "label": "platform", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxPlatformService", + "text": "SharedUxPlatformService" + } + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxUserPermissionsService", + "type": "Interface", + "tags": [], + "label": "SharedUxUserPermissionsService", + "description": [ + "\nA service providing permissions information, typically for the current user." + ], + "path": "packages/kbn-shared-ux-services/src/services/permissions.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxUserPermissionsService.canCreateNewDataView", + "type": "boolean", + "tags": [], + "label": "canCreateNewDataView", + "description": [ + "True if the user has permission to create a new Data View, false otherwise." + ], + "path": "packages/kbn-shared-ux-services/src/services/permissions.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxUserPermissionsService.canAccessFleet", + "type": "boolean", + "tags": [], + "label": "canAccessFleet", + "description": [], + "path": "packages/kbn-shared-ux-services/src/services/permissions.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.ServiceFactory", + "type": "Type", + "tags": [], + "label": "ServiceFactory", + "description": [ + "\nA factory function for creating one or more services.\n\nThe `S` generic determines the shape of the API being produced.\nThe `Parameters` generic determines what parameters are expected to\ncreate the service." + ], + "signature": [ + "(params: Parameters) => S" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.ServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServicesContext", + "type": "Type", + "tags": [], + "label": "SharedUxServicesContext", + "description": [ + "\nA type representing a component that provides the `SharedUxServices` through a\nReact Context." + ], + "signature": [ + "React.FunctionComponent<{}>" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServicesContext.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServicesContext.$2", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories", + "type": "Object", + "tags": [], + "label": "mockServiceFactories", + "description": [ + "\nA collection of mock Service Factories." + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.applicationServiceFactory", + "type": "Function", + "tags": [], + "label": "applicationServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxApplicationService", + "text": "SharedUxApplicationService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.applicationServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.docLinksServiceFactory", + "type": "Function", + "tags": [], + "label": "docLinksServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDocLinksService", + "text": "SharedUxDocLinksService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.docLinksServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.editorsServiceFactory", + "type": "Function", + "tags": [], + "label": "editorsServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxEditorsService", + "text": "SharedUxEditorsService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.editorsServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.httpServiceFactory", + "type": "Function", + "tags": [], + "label": "httpServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxHttpService", + "text": "SharedUxHttpService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.httpServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.platformServiceFactory", + "type": "Function", + "tags": [], + "label": "platformServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxPlatformService", + "text": "SharedUxPlatformService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.platformServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.userPermissionsServiceFactory", + "type": "Function", + "tags": [], + "label": "userPermissionsServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxUserPermissionsService", + "text": "SharedUxUserPermissionsService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.userPermissionsServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories", + "type": "Object", + "tags": [], + "label": "stubServiceFactories", + "description": [ + "\nA collection of stubbed service factories." + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.applicationServiceFactory", + "type": "Function", + "tags": [], + "label": "applicationServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxApplicationService", + "text": "SharedUxApplicationService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.applicationServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.docLinksServiceFactory", + "type": "Function", + "tags": [], + "label": "docLinksServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDocLinksService", + "text": "SharedUxDocLinksService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.docLinksServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.editorsServiceFactory", + "type": "Function", + "tags": [], + "label": "editorsServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxEditorsService", + "text": "SharedUxEditorsService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.editorsServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.httpServiceFactory", + "type": "Function", + "tags": [], + "label": "httpServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxHttpService", + "text": "SharedUxHttpService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.httpServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.platformServiceFactory", + "type": "Function", + "tags": [], + "label": "platformServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxPlatformService", + "text": "SharedUxPlatformService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.platformServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.userPermissionsServiceFactory", + "type": "Function", + "tags": [], + "label": "userPermissionsServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxUserPermissionsService", + "text": "SharedUxUserPermissionsService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.userPermissionsServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx new file mode 100644 index 00000000000000..4bb6c71c939031 --- /dev/null +++ b/api_docs/kbn_shared_ux_services.mdx @@ -0,0 +1,36 @@ +--- +id: kibKbnSharedUxServicesPluginApi +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-03-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. +--- +import kbnSharedUxServicesObj from './kbn_shared_ux_services.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 67 | 0 | 43 | 0 | + +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_shared_ux_storybook.devdocs.json b/api_docs/kbn_shared_ux_storybook.devdocs.json new file mode 100644 index 00000000000000..8904597032cd40 --- /dev/null +++ b/api_docs/kbn_shared_ux_storybook.devdocs.json @@ -0,0 +1,225 @@ +{ + "id": "@kbn/shared-ux-storybook", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.applicationServiceFactory", + "type": "Function", + "tags": [], + "label": "applicationServiceFactory", + "description": [ + "\nA factory function for creating for creating a storybook implementation of `SharedUXApplicationService`." + ], + "signature": [ + "() => { navigateToUrl: () => Promise; currentAppId$: ", + "BehaviorSubject", + "; }" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/application.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.docLinksServiceFactory", + "type": "Function", + "tags": [], + "label": "docLinksServiceFactory", + "description": [ + "\nA factory function for creating a Storybook implementation of `SharedUxDocLinksService`." + ], + "signature": [ + "() => { dataViewsDocLink: string; }" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/doc_links.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.editorsServiceFactory", + "type": "Function", + "tags": [], + "label": "editorsServiceFactory", + "description": [ + "\nA factory function for creating a Storybook implementation of `SharedUxEditorsService`." + ], + "signature": [ + "() => { openDataViewEditor: (options: DataViewEditorOptions) => () => void; }" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/editors.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.httpServiceFactory", + "type": "Function", + "tags": [], + "label": "httpServiceFactory", + "description": [ + "\nA factory function for creating a Storybook-based implementation of `SharedUXHttpService`." + ], + "signature": [ + "() => { addBasePath: (url: string) => string; }" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/http.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.platformServiceFactory", + "type": "Function", + "tags": [], + "label": "platformServiceFactory", + "description": [ + "\nA factory function for creating a Storybook implementation of `SharedUxPlatformService`." + ], + "signature": [ + "() => { setIsFullscreen: ", + "HandlerFunction", + "; }" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/platform.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.servicesDecorator", + "type": "Function", + "tags": [], + "label": "servicesDecorator", + "description": [ + "\nA Storybook decorator that provides the Shared UX `ServicesProvider` with Storybook-specific\nimplementations to stories." + ], + "signature": [ + "(storyFn: ", + "PartialStoryFn", + "<", + "StoryFnReactReturnType", + ">) => JSX.Element" + ], + "path": "packages/kbn-shared-ux-storybook/src/decorators.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.servicesDecorator.$1", + "type": "Function", + "tags": [], + "label": "storyFn", + "description": [], + "signature": [ + "PartialStoryFn", + "<", + "StoryFnReactReturnType", + ">" + ], + "path": "packages/kbn-shared-ux-storybook/src/decorators.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.servicesFactory", + "type": "Function", + "tags": [], + "label": "servicesFactory", + "description": [ + "\nA factory function for creating a Storybook implementation of `SharedUxServices`." + ], + "signature": [ + "(params: {}) => { application: ", + "SharedUxApplicationService", + "; docLinks: ", + "SharedUxDocLinksService", + "; editors: ", + "SharedUxEditorsService", + "; http: ", + "SharedUxHttpService", + "; permissions: ", + "SharedUxUserPermissionsService", + "; platform: ", + "SharedUxPlatformService", + "; }" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.servicesFactory.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{}" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.userPermissionsServiceFactory", + "type": "Function", + "tags": [], + "label": "userPermissionsServiceFactory", + "description": [ + "\nA factory function for creating a Storybook implementation of `SharedUxUserPermissionsService`." + ], + "signature": [ + "() => { canCreateNewDataView: true; canAccessFleet: true; }" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/permissions.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx new file mode 100644 index 00000000000000..77b1cdff6f7926 --- /dev/null +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnSharedUxStorybookPluginApi +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-03-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. +--- +import kbnSharedUxStorybookObj from './kbn_shared_ux_storybook.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 10 | 0 | 2 | 0 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_shared_ux_utility.devdocs.json b/api_docs/kbn_shared_ux_utility.devdocs.json new file mode 100644 index 00000000000000..09a0ce6dedea55 --- /dev/null +++ b/api_docs/kbn_shared_ux_utility.devdocs.json @@ -0,0 +1,177 @@ +{ + "id": "@kbn/shared-ux-utility", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.Fallback", + "type": "Function", + "tags": [], + "label": "Fallback", + "description": [ + "\nA simple implementation of `React.Suspense.fallback` that renders a loading spinner." + ], + "signature": [ + "() => JSX.Element" + ], + "path": "packages/kbn-shared-ux-utility/src/fallback.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.getClosestLink", + "type": "Function", + "tags": [], + "label": "getClosestLink", + "description": [ + "\nReturns the closest anchor (``) element in the element parents (self included) up\nto the given container (excluded), or undefined if none is found." + ], + "signature": [ + "(element: HTMLElement | null | undefined, container?: HTMLElement | undefined) => HTMLAnchorElement | undefined" + ], + "path": "packages/kbn-shared-ux-utility/src/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.getClosestLink.$1", + "type": "CompoundType", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "HTMLElement | null | undefined" + ], + "path": "packages/kbn-shared-ux-utility/src/utils.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.getClosestLink.$2", + "type": "Object", + "tags": [], + "label": "container", + "description": [], + "signature": [ + "HTMLElement | undefined" + ], + "path": "packages/kbn-shared-ux-utility/src/utils.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.hasActiveModifierKey", + "type": "Function", + "tags": [], + "label": "hasActiveModifierKey", + "description": [ + "\nReturns true if any modifier key is active on the event, false otherwise." + ], + "signature": [ + "(event: React.MouseEvent) => boolean" + ], + "path": "packages/kbn-shared-ux-utility/src/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.hasActiveModifierKey.$1", + "type": "Object", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "React.MouseEvent" + ], + "path": "packages/kbn-shared-ux-utility/src/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.withSuspense", + "type": "Function", + "tags": [], + "label": "withSuspense", + "description": [ + "\nA HOC which supplies React.Suspense with a fallback component, and a `EuiErrorBoundary` to contain errors." + ], + "signature": [ + "

(Component: React.ComponentType

, fallback?: React.ReactElement> | null) => React.ForwardRefExoticComponent & React.RefAttributes>" + ], + "path": "packages/kbn-shared-ux-utility/src/with_suspense.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.withSuspense.$1", + "type": "CompoundType", + "tags": [], + "label": "Component", + "description": [ + "A component deferred by `React.lazy`" + ], + "signature": [ + "React.ComponentType

" + ], + "path": "packages/kbn-shared-ux-utility/src/with_suspense.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/shared-ux-utility", + "id": "def-common.withSuspense.$2", + "type": "CompoundType", + "tags": [], + "label": "fallback", + "description": [ + "A fallback component to render while things load; default is `Fallback` from SharedUX." + ], + "signature": [ + "React.ReactElement> | null" + ], + "path": "packages/kbn-shared-ux-utility/src/with_suspense.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx new file mode 100644 index 00000000000000..1fecde17298f4a --- /dev/null +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnSharedUxUtilityPluginApi +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-03-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. +--- +import kbnSharedUxUtilityObj from './kbn_shared_ux_utility.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 9 | 0 | 3 | 0 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index 4a1399f8811999..4ab53cd7f51a8a 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-03-15 +date: 2022-03-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_storybook.mdx b/api_docs/kbn_storybook.mdx index b1a53c30d5ab28..eea5a68825cec1 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-03-15 +date: 2022-03-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 facf413cece8ec..e96ae96c8f655b 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-03-15 +date: 2022-03-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 78b8a6981b8d3d..dd0a8212b5b9ad 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-03-15 +date: 2022-03-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 a1b7f3bd45fe9c..f131a92f41b9f4 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-03-15 +date: 2022-03-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_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index 762c5411ab8217..15191f8cf66401 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-03-15 +date: 2022-03-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_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index 87a0fc5a32084a..18a40d6fe9c84c 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/kbn_ui_theme.devdocs.json index 48f661a45c7754..c4272d206e8bd0 100644 --- a/api_docs/kbn_ui_theme.devdocs.json +++ b/api_docs/kbn_ui_theme.devdocs.json @@ -52,7 +52,7 @@ "label": "Theme", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -82,7 +82,7 @@ "label": "euiDarkVars", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -96,7 +96,7 @@ "label": "euiLightVars", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -112,7 +112,7 @@ "\nEUI Theme vars that automatically adjust to light/dark theme" ], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index cd20c8c3e249bf..f1279e3cafe37e 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-03-15 +date: 2022-03-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 f541ca219791bc..8f705b6e81cdd0 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-03-15 +date: 2022-03-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_utils.mdx b/api_docs/kbn_utils.mdx index dcc983235d2118..1781ed53aff90c 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-03-15 +date: 2022-03-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/kibana_overview.mdx b/api_docs/kibana_overview.mdx index c0aa1cde1c4c19..be09d0dd97ec40 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-03-15 +date: 2022-03-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 58de4a6f21bcfa..74f669998457e2 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -1454,7 +1454,10 @@ "parentPluginId": "kibanaReact", "id": "def-public.RedirectAppLinks", "type": "Function", - "tags": [], + "tags": [ + "deprecated", + "kbn-shared-ux-components" + ], "label": "RedirectAppLinks", "description": [ "\nUtility component that will intercept click events on children anchor (``) elements to call\n`application.navigateToUrl` with the link's href. This will trigger SPA friendly navigation\nwhen the link points to a valid Kibana app.\n" @@ -1463,7 +1466,361 @@ "({ application, children, className, ...otherProps }: React.PropsWithChildren) => JSX.Element" ], "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "esUiShared", + "path": "src/plugins/es_ui_shared/public/components/view_api_request_flyout/view_api_request_flyout.tsx" + }, + { + "plugin": "esUiShared", + "path": "src/plugins/es_ui_shared/public/components/view_api_request_flyout/view_api_request_flyout.tsx" + }, + { + "plugin": "esUiShared", + "path": "src/plugins/es_ui_shared/public/components/view_api_request_flyout/view_api_request_flyout.tsx" + }, + { + "plugin": "home", + "path": "src/plugins/home/public/application/application.tsx" + }, + { + "plugin": "home", + "path": "src/plugins/home/public/application/application.tsx" + }, + { + "plugin": "home", + "path": "src/plugins/home/public/application/application.tsx" + }, + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/management/spaces_management_app.tsx" + }, + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/management/spaces_management_app.tsx" + }, + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/management/spaces_management_app.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/application/index.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/application/index.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/application/index.tsx" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/integrations/app.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/integrations/app.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/integrations/app.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/app.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/app.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/app.tsx" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/routing/app_root.tsx" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/routing/app_root.tsx" + }, + { + "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" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/public/application/index.tsx" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/public/application/index.tsx" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/public/application/index.tsx" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/public/shared_imports.ts" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/apps/uptime_app.tsx" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/apps/uptime_app.tsx" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/public/apps/uptime_app.tsx" + }, + { + "plugin": "ux", + "path": "x-pack/plugins/ux/public/application/ux_app.tsx" + }, + { + "plugin": "ux", + "path": "x-pack/plugins/ux/public/application/ux_app.tsx" + }, + { + "plugin": "ux", + "path": "x-pack/plugins/ux/public/application/ux_app.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/add_data/add_data.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/add_data/add_data.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/add_data/add_data.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" + }, + { + "plugin": "home", + "path": "src/plugins/home/public/application/components/add_data/add_data.tsx" + }, + { + "plugin": "home", + "path": "src/plugins/home/public/application/components/add_data/add_data.tsx" + }, + { + "plugin": "home", + "path": "src/plugins/home/public/application/components/add_data/add_data.tsx" + } + ], "children": [ { "parentPluginId": "kibanaReact", @@ -4428,7 +4785,7 @@ "label": "eui", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 2fa182ff2a311e..cacc37e34cc655 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-03-15 +date: 2022-03-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 bac689f56b11c6..11bf23492a84b0 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-03-15 +date: 2022-03-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/lens.devdocs.json b/api_docs/lens.devdocs.json index 3b82fc075430c2..8fdad5c360c6dd 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -63,8 +63,6 @@ "text": "CardinalityIndexPatternColumn" }, " extends ", - "FormattedIndexPatternColumn", - ",", { "pluginId": "lens", "scope": "public", @@ -88,6 +86,179 @@ ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx", "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.CardinalityIndexPatternColumn.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ emptyAsNull?: boolean | undefined; format?: ", + "FormatParams", + " | undefined; } | undefined" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI", + "type": "Interface", + "tags": [], + "label": "DatasourcePublicAPI", + "description": [ + "\nThis is an API provided to visualizations by the frame, which calls the publicAPI on the datasource" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.datasourceId", + "type": "string", + "tags": [], + "label": "datasourceId", + "description": [], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getTableSpec", + "type": "Function", + "tags": [], + "label": "getTableSpec", + "description": [], + "signature": [ + "() => { columnId: string; fields: string[]; }[]" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getOperationForColumnId", + "type": "Function", + "tags": [], + "label": "getOperationForColumnId", + "description": [], + "signature": [ + "(columnId: string) => ", + "OperationDescriptor", + " | null" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getOperationForColumnId.$1", + "type": "string", + "tags": [], + "label": "columnId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getVisualDefaults", + "type": "Function", + "tags": [], + "label": "getVisualDefaults", + "description": [ + "\nCollect all default visual values given the current state" + ], + "signature": [ + "() => Record>" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getSourceId", + "type": "Function", + "tags": [], + "label": "getSourceId", + "description": [ + "\nRetrieve the specific source id for the current state" + ], + "signature": [ + "() => string | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getFilters", + "type": "Function", + "tags": [], + "label": "getFilters", + "description": [ + "\nCollect all defined filters from all the operations in the layer" + ], + "signature": [ + "(activeData?: Record | undefined) => Record<\"enabled\" | \"disabled\", { kuery: ", + "Query", + "[][]; lucene: ", + "Query", + "[][]; }>" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getFilters.$1", + "type": "Object", + "tags": [], + "label": "activeData", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -134,7 +305,7 @@ "label": "layerType", "description": [], "signature": [ - "\"data\" | \"referenceLine\"" + "\"data\" | \"annotations\" | \"referenceLine\"" ], "path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx", "deprecated": false @@ -166,6 +337,19 @@ "path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx", "deprecated": false }, + { + "parentPluginId": "lens", + "id": "def-public.DatatableVisualizationState.headerRowHeight", + "type": "CompoundType", + "tags": [], + "label": "headerRowHeight", + "description": [], + "signature": [ + "\"custom\" | \"auto\" | \"single\" | undefined" + ], + "path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx", + "deprecated": false + }, { "parentPluginId": "lens", "id": "def-public.DatatableVisualizationState.rowHeightLines", @@ -179,6 +363,19 @@ "path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx", "deprecated": false }, + { + "parentPluginId": "lens", + "id": "def-public.DatatableVisualizationState.headerRowHeightLines", + "type": "number", + "tags": [], + "label": "headerRowHeightLines", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx", + "deprecated": false + }, { "parentPluginId": "lens", "id": "def-public.DatatableVisualizationState.paging", @@ -244,7 +441,7 @@ "label": "params", "description": [], "signature": [ - "{ interval: string; ignoreTimeRange?: boolean | undefined; dropPartials?: boolean | undefined; }" + "{ interval: string; ignoreTimeRange?: boolean | undefined; includeEmptyRows?: boolean | undefined; dropPartials?: boolean | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx", "deprecated": false @@ -653,7 +850,7 @@ "label": "params", "description": [], "signature": [ - "{ sortField: string; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }" + "{ sortField: string; showArrayValues: boolean; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx", "deprecated": false @@ -1456,7 +1653,7 @@ "MODES_TYPES", "; maxBars: number | \"auto\"; ranges: ", "RangeTypeLens", - "[]; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; parentFormat?: { id: string; params?: { id?: string | undefined; template?: string | undefined; replaceInfinity?: boolean | undefined; } | undefined; } | undefined; }" + "[]; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; includeEmptyRows?: boolean | undefined; parentFormat?: { id: string; params?: { id?: string | undefined; template?: string | undefined; replaceInfinity?: boolean | undefined; } | undefined; } | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx", "deprecated": false @@ -1686,12 +1883,242 @@ "id": "def-public.StaticValueIndexPatternColumn.params", "type": "Object", "tags": [], - "label": "params", - "description": [], + "label": "params", + "description": [], + "signature": [ + "{ value?: string | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/static_value.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest", + "type": "Interface", + "tags": [], + "label": "SuggestionRequest", + "description": [ + "\nObject passed to `getSuggestions` of a visualization.\nIt contains a possible table the current datasource could\nprovide and the state of the visualization if it is currently active.\n\nIf the current datasource suggests multiple tables, `getSuggestions`\nis called multiple times with separate `SuggestionRequest` objects." + ], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.SuggestionRequest", + "text": "SuggestionRequest" + }, + "" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest.table", + "type": "Object", + "tags": [], + "label": "table", + "description": [ + "\nA table configuration the datasource could provide." + ], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.TableSuggestion", + "text": "TableSuggestion" + } + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [ + "\nState is only passed if the visualization is active." + ], + "signature": [ + "T | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest.mainPalette", + "type": "Object", + "tags": [], + "label": "mainPalette", + "description": [], + "signature": [ + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.PaletteOutput", + "text": "PaletteOutput" + }, + "<{ [key: string]: unknown; }> | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest.isFromContext", + "type": "CompoundType", + "tags": [], + "label": "isFromContext", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest.keptLayerIds", + "type": "Array", + "tags": [], + "label": "keptLayerIds", + "description": [ + "\nThe visualization needs to know which table is being suggested" + ], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest.subVisualizationId", + "type": "string", + "tags": [], + "label": "subVisualizationId", + "description": [ + "\nDifferent suggestions can be generated for each subtype of the visualization" + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest.activeData", + "type": "Object", + "tags": [], + "label": "activeData", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-public.TableSuggestion", + "type": "Interface", + "tags": [], + "label": "TableSuggestion", + "description": [ + "\nA possible table a datasource can create. This object is passed to the visualization\nwhich tries to build a meaningful visualization given the shape of the table. If this\nis possible, the visualization returns a `VisualizationSuggestion` object" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.TableSuggestion.isMultiRow", + "type": "boolean", + "tags": [], + "label": "isMultiRow", + "description": [ + "\nFlag indicating whether the table will include more than one column.\nThis is not the case for example for a single metric aggregation" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.TableSuggestion.columns", + "type": "Array", + "tags": [], + "label": "columns", + "description": [ + "\nThe columns of the table. Each column has to be mapped to a dimension in a chart. If a visualization\ncan't use all columns of a suggestion, it should not return a `VisualizationSuggestion` based on it\nbecause there would be unreferenced columns" + ], + "signature": [ + "TableSuggestionColumn", + "[]" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.TableSuggestion.layerId", + "type": "string", + "tags": [], + "label": "layerId", + "description": [ + "\nThe layer this table will replace. This is only relevant if the visualization this suggestion is passed\nis currently active and has multiple layers configured. If this suggestion is applied, the table of this\nlayer will be replaced by the columns specified in this suggestion" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.TableSuggestion.label", + "type": "string", + "tags": [], + "label": "label", + "description": [ + "\nA label describing the table. This can be used to provide a title for the `VisualizationSuggestion`,\nbut the visualization can also decide to overwrite it." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.TableSuggestion.changeType", + "type": "CompoundType", + "tags": [], + "label": "changeType", + "description": [ + "\nThe change type indicates what was changed in this table compared to the currently active table of this layer." + ], "signature": [ - "{ value?: string | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }" + "\"layers\" | \"initial\" | \"unchanged\" | \"reduced\" | \"extended\" | \"reorder\"" ], - "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/static_value.tsx", + "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false } ], @@ -2251,7 +2678,7 @@ "signature": [ "(state?: T | undefined, frame?: Pick<", "FramePublicAPI", - ", \"datasourceLayers\" | \"activeData\"> | undefined) => { type: ", + ", \"activeData\" | \"datasourceLayers\"> | undefined) => { type: ", { "pluginId": "lens", "scope": "common", @@ -2261,7 +2688,7 @@ }, "; label: string; icon?: ", "IconType", - " | undefined; disabled?: boolean | undefined; toolTipContent?: string | undefined; initialDimensions?: { groupId: string; columnId: string; dataType: string; label: string; staticValue: unknown; }[] | undefined; }[]" + " | undefined; noDatasource?: boolean | undefined; disabled?: boolean | undefined; toolTipContent?: string | undefined; initialDimensions?: { columnId: string; groupId: string; staticValue?: unknown; }[] | undefined; }[]" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -2290,7 +2717,7 @@ "signature": [ "Pick<", "FramePublicAPI", - ", \"datasourceLayers\" | \"activeData\"> | undefined" + ", \"activeData\" | \"datasourceLayers\"> | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -2709,6 +3136,127 @@ ], "returnComment": [] }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.renderDimensionTrigger", + "type": "Function", + "tags": [], + "label": "renderDimensionTrigger", + "description": [ + "\nRenders dimension trigger. Used only for noDatasource layers" + ], + "signature": [ + "((props: { columnId: string; label: string; hideTooltip?: boolean | undefined; invalid?: boolean | undefined; invalidMessage?: string | undefined; }) => JSX.Element | null) | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Visualization.renderDimensionTrigger.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Visualization.renderDimensionTrigger.$1.columnId", + "type": "string", + "tags": [], + "label": "columnId", + "description": [], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.renderDimensionTrigger.$1.label", + "type": "string", + "tags": [], + "label": "label", + "description": [], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.renderDimensionTrigger.$1.hideTooltip", + "type": "CompoundType", + "tags": [], + "label": "hideTooltip", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.renderDimensionTrigger.$1.invalid", + "type": "CompoundType", + "tags": [], + "label": "invalid", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.renderDimensionTrigger.$1.invalidMessage", + "type": "string", + "tags": [], + "label": "invalidMessage", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getUniqueLabels", + "type": "Function", + "tags": [], + "label": "getUniqueLabels", + "description": [ + "\nCreates map of columns ids and unique lables. Used only for noDatasource layers" + ], + "signature": [ + "((state: T) => Record) | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getUniqueLabels.$1", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "T" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "lens", "id": "def-public.Visualization.getSuggestions", @@ -2720,9 +3268,21 @@ ], "signature": [ "(context: ", - "SuggestionRequest", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.SuggestionRequest", + "text": "SuggestionRequest" + }, ") => ", - "VisualizationSuggestion", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.VisualizationSuggestion", + "text": "VisualizationSuggestion" + }, "[]" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -2736,7 +3296,13 @@ "label": "context", "description": [], "signature": [ - "SuggestionRequest", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.SuggestionRequest", + "text": "SuggestionRequest" + }, "" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -2755,7 +3321,13 @@ "description": [], "signature": [ "(state: T, datasourceLayers: Record, attributes?: Partial<{ title: string; description: string; }> | undefined) => string | ", { "pluginId": "expressions", @@ -2792,7 +3364,13 @@ "description": [], "signature": [ "Record" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -2827,7 +3405,13 @@ ], "signature": [ "((state: T, datasourceLayers: Record) => string | ", { "pluginId": "expressions", @@ -2864,7 +3448,13 @@ "description": [], "signature": [ "Record" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -2885,7 +3475,13 @@ ], "signature": [ "(state: T, datasourceLayers?: Record | undefined) => { shortMessage: string; longMessage: React.ReactNode; }[] | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -2914,7 +3510,13 @@ "description": [], "signature": [ "Record | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -3028,6 +3630,100 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "lens", + "id": "def-public.VisualizationSuggestion", + "type": "Interface", + "tags": [], + "label": "VisualizationSuggestion", + "description": [ + "\nA possible configuration of a given visualization. It is based on a `TableSuggestion`.\nSuggestion might be shown in the UI to be chosen by the user directly, but they are\nalso applied directly under some circumstances (dragging in the first field from the data\npanel or switching to another visualization in the chart switcher)." + ], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.VisualizationSuggestion", + "text": "VisualizationSuggestion" + }, + "" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.VisualizationSuggestion.score", + "type": "number", + "tags": [], + "label": "score", + "description": [ + "\nThe score of a suggestion should indicate how valuable the suggestion is. It is used\nto rank multiple suggestions of multiple visualizations. The number should be between 0 and 1" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.VisualizationSuggestion.hide", + "type": "CompoundType", + "tags": [], + "label": "hide", + "description": [ + "\nFlag indicating whether this suggestion should not be advertised to the user. It is still\nconsidered in scenarios where the available suggestion with the highest suggestion is applied\ndirectly." + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.VisualizationSuggestion.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nDescriptive title of the suggestion. Should be as short as possible. This title is shown if\nthe suggestion is advertised to the user and will also show either the `previewExpression` or\nthe `previewIcon`" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.VisualizationSuggestion.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [ + "\nThe new state of the visualization if this suggestion is applied." + ], + "signature": [ + "T" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.VisualizationSuggestion.previewIcon", + "type": "CompoundType", + "tags": [], + "label": "previewIcon", + "description": [ + "\nAn EUI icon type shown instead of the preview expression." + ], + "signature": [ + "string | React.ComponentType<{}>" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "lens", "id": "def-public.XYState", @@ -3097,6 +3793,32 @@ "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "deprecated": false }, + { + "parentPluginId": "lens", + "id": "def-public.XYState.emphasizeFitting", + "type": "CompoundType", + "tags": [], + "label": "emphasizeFitting", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYState.endValue", + "type": "CompoundType", + "tags": [], + "label": "endValue", + "description": [], + "signature": [ + "\"None\" | \"Zero\" | \"Nearest\" | undefined" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false + }, { "parentPluginId": "lens", "id": "def-public.XYState.yLeftExtent", @@ -3432,8 +4154,6 @@ "label": "AvgIndexPatternColumn", "description": [], "signature": [ - "FormattedIndexPatternColumn", - " & ", { "pluginId": "lens", "scope": "public", @@ -3441,7 +4161,9 @@ "section": "def-public.FieldBasedIndexPatternColumn", "text": "FieldBasedIndexPatternColumn" }, - " & { operationType: \"average\"; }" + " & { operationType: \"average\"; params?: { emptyAsNull?: boolean | undefined; format?: ", + "FormatParams", + " | undefined; } | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx", "deprecated": false, @@ -3472,8 +4194,6 @@ "label": "CountIndexPatternColumn", "description": [], "signature": [ - "FormattedIndexPatternColumn", - " & ", { "pluginId": "lens", "scope": "public", @@ -3481,7 +4201,9 @@ "section": "def-public.FieldBasedIndexPatternColumn", "text": "FieldBasedIndexPatternColumn" }, - " & { operationType: \"count\"; }" + " & { operationType: \"count\"; params?: { emptyAsNull?: boolean | undefined; format?: ", + "FormatParams", + " | undefined; } | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx", "deprecated": false, @@ -3677,8 +4399,6 @@ "label": "MaxIndexPatternColumn", "description": [], "signature": [ - "FormattedIndexPatternColumn", - " & ", { "pluginId": "lens", "scope": "public", @@ -3686,7 +4406,9 @@ "section": "def-public.FieldBasedIndexPatternColumn", "text": "FieldBasedIndexPatternColumn" }, - " & { operationType: \"max\"; }" + " & { operationType: \"max\"; params?: { emptyAsNull?: boolean | undefined; format?: ", + "FormatParams", + " | undefined; } | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx", "deprecated": false, @@ -3700,8 +4422,6 @@ "label": "MedianIndexPatternColumn", "description": [], "signature": [ - "FormattedIndexPatternColumn", - " & ", { "pluginId": "lens", "scope": "public", @@ -3709,7 +4429,9 @@ "section": "def-public.FieldBasedIndexPatternColumn", "text": "FieldBasedIndexPatternColumn" }, - " & { operationType: \"median\"; }" + " & { operationType: \"median\"; params?: { emptyAsNull?: boolean | undefined; format?: ", + "FormatParams", + " | undefined; } | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx", "deprecated": false, @@ -3723,8 +4445,6 @@ "label": "MinIndexPatternColumn", "description": [], "signature": [ - "FormattedIndexPatternColumn", - " & ", { "pluginId": "lens", "scope": "public", @@ -3732,7 +4452,9 @@ "section": "def-public.FieldBasedIndexPatternColumn", "text": "FieldBasedIndexPatternColumn" }, - " & { operationType: \"min\"; }" + " & { operationType: \"min\"; params?: { emptyAsNull?: boolean | undefined; format?: ", + "FormatParams", + " | undefined; } | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx", "deprecated": false, @@ -3869,8 +4591,6 @@ "label": "SumIndexPatternColumn", "description": [], "signature": [ - "FormattedIndexPatternColumn", - " & ", { "pluginId": "lens", "scope": "public", @@ -3878,7 +4598,9 @@ "section": "def-public.FieldBasedIndexPatternColumn", "text": "FieldBasedIndexPatternColumn" }, - " & { operationType: \"sum\"; }" + " & { operationType: \"sum\"; params?: { emptyAsNull?: boolean | undefined; format?: ", + "FormatParams", + " | undefined; } | undefined; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx", "deprecated": false, @@ -3988,7 +4710,9 @@ "signature": [ "XYDataLayerConfig", " | ", - "XYReferenceLineLayerConfig" + "XYReferenceLineLayerConfig", + " | ", + "XYAnnotationLayerConfig" ], "path": "x-pack/plugins/lens/common/expressions/xy_chart/layer_config/index.ts", "deprecated": false, @@ -4018,7 +4742,7 @@ "label": "layerTypes", "description": [], "signature": [ - "{ readonly DATA: \"data\"; readonly REFERENCELINE: \"referenceLine\"; }" + "{ readonly DATA: \"data\"; readonly REFERENCELINE: \"referenceLine\"; readonly ANNOTATIONS: \"annotations\"; }" ], "path": "x-pack/plugins/lens/common/constants.ts", "deprecated": false, @@ -5832,7 +6556,7 @@ "label": "layerType", "description": [], "signature": [ - "\"data\" | \"referenceLine\"" + "\"data\" | \"annotations\" | \"referenceLine\"" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false @@ -6544,7 +7268,7 @@ "label": "LayerType", "description": [], "signature": [ - "\"data\" | \"referenceLine\"" + "\"data\" | \"annotations\" | \"referenceLine\"" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false, @@ -6751,7 +7475,7 @@ "label": "layerTypes", "description": [], "signature": [ - "{ readonly DATA: \"data\"; readonly REFERENCELINE: \"referenceLine\"; }" + "{ readonly DATA: \"data\"; readonly REFERENCELINE: \"referenceLine\"; readonly ANNOTATIONS: \"annotations\"; }" ], "path": "x-pack/plugins/lens/common/constants.ts", "deprecated": false, diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 8a3765c99f5379..84a89dd791f664 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 395 | 0 | 343 | 43 | +| 438 | 0 | 363 | 44 | ## Client diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index 28fdba4aa9a8bf..256fef726f3547 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-03-15 +date: 2022-03-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 d97318c5836769..54f934702c0eea 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/licensing.devdocs.json index 40e6f7874ec344..7d63612c554c21 100644 --- a/api_docs/licensing.devdocs.json +++ b/api_docs/licensing.devdocs.json @@ -103,6 +103,7 @@ ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [] }, { @@ -460,6 +461,7 @@ ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "apm", @@ -717,6 +719,7 @@ ], "path": "x-pack/plugins/licensing/public/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "security", @@ -790,6 +793,7 @@ ], "path": "x-pack/plugins/licensing/public/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [], "children": [], "returnComment": [] @@ -1789,6 +1793,7 @@ ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [] }, { @@ -2193,6 +2198,7 @@ ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "apm", @@ -2494,6 +2500,7 @@ ], "path": "x-pack/plugins/licensing/server/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "spaces", @@ -2615,6 +2622,7 @@ ], "path": "x-pack/plugins/licensing/server/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "mapsEms", diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 203b61694c4ab0..be18c4a645fa2f 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-03-15 +date: 2022-03-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.mdx b/api_docs/lists.mdx index d1e5cffc608018..85a40eb0e3f3bf 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 541281ded0c0ff..a662b63d617313 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-03-15 +date: 2022-03-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 c6b9ab0d2b2791..157684b198652d 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -812,6 +812,50 @@ ], "returnComment": [] }, + { + "parentPluginId": "maps", + "id": "def-public.MapEmbeddable.updateLayerById", + "type": "Function", + "tags": [], + "label": "updateLayerById", + "description": [], + "signature": [ + "(layerDescriptor: ", + { + "pluginId": "maps", + "scope": "common", + "docId": "kibMapsPluginApi", + "section": "def-common.LayerDescriptor", + "text": "LayerDescriptor" + }, + ") => void" + ], + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "maps", + "id": "def-public.MapEmbeddable.updateLayerById.$1", + "type": "Object", + "tags": [], + "label": "layerDescriptor", + "description": [], + "signature": [ + { + "pluginId": "maps", + "scope": "common", + "docId": "kibMapsPluginApi", + "section": "def-common.LayerDescriptor", + "text": "LayerDescriptor" + } + ], + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "maps", "id": "def-public.MapEmbeddable.onSingleValueTrigger", @@ -1177,6 +1221,16 @@ "description": [], "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", "deprecated": false + }, + { + "parentPluginId": "maps", + "id": "def-public.EMSTermJoinConfig.displayName", + "type": "string", + "tags": [], + "label": "displayName", + "description": [], + "path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts", + "deprecated": false } ], "initialIsOpen": false @@ -3344,6 +3398,17 @@ "path": "x-pack/plugins/maps/common/constants.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "maps", + "id": "def-common.VECTOR_STYLES", + "type": "Enum", + "tags": [], + "label": "VECTOR_STYLES", + "description": [], + "path": "x-pack/plugins/maps/common/constants.ts", + "deprecated": false, + "initialIsOpen": false } ], "misc": [ diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 70190edd4f35c8..1ea8654c4245f8 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 216 | 0 | 215 | 27 | +| 220 | 0 | 219 | 27 | ## Client diff --git a/api_docs/maps_ems.devdocs.json b/api_docs/maps_ems.devdocs.json index 87808d88def770..18ef0a3cf340b3 100644 --- a/api_docs/maps_ems.devdocs.json +++ b/api_docs/maps_ems.devdocs.json @@ -953,7 +953,7 @@ "label": "DEFAULT_EMS_LANDING_PAGE_URL", "description": [], "signature": [ - "\"https://maps.elastic.co/v8.1\"" + "\"https://maps.elastic.co/v8.2\"" ], "path": "src/plugins/maps_ems/common/ems_defaults.ts", "deprecated": false, diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 260a2fdf6ddedb..9c1b685711d4be 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-03-15 +date: 2022-03-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/metrics_entities.mdx b/api_docs/metrics_entities.mdx index b760e1c32b85c4..758efed1b5f329 100644 --- a/api_docs/metrics_entities.mdx +++ b/api_docs/metrics_entities.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/metricsEntities title: "metricsEntities" image: https://source.unsplash.com/400x175/?github summary: API docs for the metricsEntities plugin -date: 2022-03-15 +date: 2022-03-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'metricsEntities'] warning: This document is auto-generated and 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 c5e7ee6d090690..bfcdfea6040431 100644 --- a/api_docs/ml.devdocs.json +++ b/api_docs/ml.devdocs.json @@ -1256,8 +1256,8 @@ "description": [], "signature": [ "({ rowIndex, columnId, setCellProps, }: { rowIndex: number; columnId: string; setCellProps: (props: ", - "CommonProps", - " & React.HTMLAttributes) => void; }) => any" + "EuiDataGridSetCellProps", + ") => void; }) => any" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false, @@ -1272,8 +1272,8 @@ "description": [], "signature": [ "{ rowIndex: number; columnId: string; setCellProps: (props: ", - "CommonProps", - " & React.HTMLAttributes) => void; }" + "EuiDataGridSetCellProps", + ") => void; }" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false @@ -1425,8 +1425,8 @@ "description": [], "signature": [ "({ rowIndex, columnId, setCellProps, }: { rowIndex: number; columnId: string; setCellProps: (props: ", - "CommonProps", - " & React.HTMLAttributes) => void; }) => any" + "EuiDataGridSetCellProps", + ") => void; }) => any" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false, @@ -1441,8 +1441,8 @@ "description": [], "signature": [ "{ rowIndex: number; columnId: string; setCellProps: (props: ", - "CommonProps", - " & React.HTMLAttributes) => void; }" + "EuiDataGridSetCellProps", + ") => void; }" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false @@ -1478,7 +1478,7 @@ "label": "ML_PAGES", "description": [], "signature": [ - "{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly TRAINED_MODELS_MANAGE: \"trained_models\"; readonly TRAINED_MODELS_NODES: \"trained_models/nodes\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly ACCESS_DENIED: \"access-denied\"; readonly OVERVIEW: \"overview\"; }" + "{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_SOURCE_SELECTION: \"data_frame_analytics/source_selection\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly TRAINED_MODELS_MANAGE: \"trained_models\"; readonly TRAINED_MODELS_NODES: \"trained_models/nodes\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly ACCESS_DENIED: \"access-denied\"; readonly OVERVIEW: \"overview\"; }" ], "path": "x-pack/plugins/ml/common/constants/locator.ts", "deprecated": false, diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 6302338bcab5b3..4f8c7d8db29dad 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-03-15 +date: 2022-03-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 f6c27fd9d0788d..909e1991311ef4 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/monitoring_collection.devdocs.json index 84e1cad4b16a05..bca169a38e523f 100644 --- a/api_docs/monitoring_collection.devdocs.json +++ b/api_docs/monitoring_collection.devdocs.json @@ -11,7 +11,89 @@ "server": { "classes": [], "functions": [], - "interfaces": [], + "interfaces": [ + { + "parentPluginId": "monitoringCollection", + "id": "def-server.Metric", + "type": "Interface", + "tags": [], + "label": "Metric", + "description": [], + "signature": [ + { + "pluginId": "monitoringCollection", + "scope": "server", + "docId": "kibMonitoringCollectionPluginApi", + "section": "def-server.Metric", + "text": "Metric" + }, + "" + ], + "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "monitoringCollection", + "id": "def-server.Metric.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "monitoringCollection", + "id": "def-server.Metric.schema", + "type": "Object", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + "{ [Key in keyof Required]: Required[Key] extends (infer U)[] ? { type: \"array\"; items: ", + "RecursiveMakeSchemaFrom", + "; } : ", + "RecursiveMakeSchemaFrom", + "[Key]>; }" + ], + "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "monitoringCollection", + "id": "def-server.Metric.fetch", + "type": "Function", + "tags": [], + "label": "fetch", + "description": [], + "signature": [ + "() => Promise<", + { + "pluginId": "monitoringCollection", + "scope": "server", + "docId": "kibMonitoringCollectionPluginApi", + "section": "def-server.MetricResult", + "text": "MetricResult" + }, + " | ", + { + "pluginId": "monitoringCollection", + "scope": "server", + "docId": "kibMonitoringCollectionPluginApi", + "section": "def-server.MetricResult", + "text": "MetricResult" + }, + "[]>" + ], + "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], "enums": [], "misc": [ { @@ -64,7 +146,13 @@ "description": [], "signature": [ "(metric: ", - "Metric", + { + "pluginId": "monitoringCollection", + "scope": "server", + "docId": "kibMonitoringCollectionPluginApi", + "section": "def-server.Metric", + "text": "Metric" + }, ") => void" ], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", @@ -78,7 +166,13 @@ "label": "metric", "description": [], "signature": [ - "Metric", + { + "pluginId": "monitoringCollection", + "scope": "server", + "docId": "kibMonitoringCollectionPluginApi", + "section": "def-server.Metric", + "text": "Metric" + }, "" ], "path": "x-pack/plugins/monitoring_collection/server/plugin.ts", diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index 86ad88a64974b8..65e04e6bcb35aa 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-03-15 +date: 2022-03-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. --- @@ -18,13 +18,16 @@ Contact [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitorin | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 5 | 0 | 5 | 1 | +| 9 | 0 | 9 | 0 | ## Server ### Setup +### Interfaces + + ### Consts, variables and types diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index f904cba6cbbec6..8220e61a22c8b5 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-03-15 +date: 2022-03-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 1a771535086480..2b3ab879f7dbc8 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-03-15 +date: 2022-03-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 049c3f8e3f5ea4..92b1a82e29de60 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -280,6 +280,48 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.DatePickerContextProvider", + "type": "Function", + "tags": [], + "label": "DatePickerContextProvider", + "description": [], + "signature": [ + "({ children }: { children: React.ReactElement>; }) => JSX.Element" + ], + "path": "x-pack/plugins/observability/public/context/date_picker_context.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.DatePickerContextProvider.$1", + "type": "Object", + "tags": [], + "label": "{ children }", + "description": [], + "path": "x-pack/plugins/observability/public/context/date_picker_context.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.DatePickerContextProvider.$1.children", + "type": "Object", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "React.ReactElement>" + ], + "path": "x-pack/plugins/observability/public/context/date_picker_context.tsx", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.ExploratoryView", @@ -2311,6 +2353,39 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.InfraLogsHasDataResponse", + "type": "Interface", + "tags": [], + "label": "InfraLogsHasDataResponse", + "description": [], + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.InfraLogsHasDataResponse.hasData", + "type": "boolean", + "tags": [], + "label": "hasData", + "description": [], + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "deprecated": false + }, + { + "parentPluginId": "observability", + "id": "def-public.InfraLogsHasDataResponse.indices", + "type": "string", + "tags": [], + "label": "indices", + "description": [], + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.InfraMetricsHasDataResponse", @@ -2932,10 +3007,19 @@ { "parentPluginId": "observability", "id": "def-public.ObservabilityHasDataResponse.infra_logs", - "type": "boolean", + "type": "Object", "tags": [], "label": "infra_logs", "description": [], + "signature": [ + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.InfraLogsHasDataResponse", + "text": "InfraLogsHasDataResponse" + } + ], "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", "deprecated": false }, @@ -3165,207 +3249,7 @@ "label": "dataViews", "description": [], "signature": [ - "{ create: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>; get: (id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; refreshFields: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ") => Promise; fieldArrayToMap: (fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - "; createAndSave: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; createSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; updateSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getCanSaveSync: () => boolean; }" + "DataViewsServicePublic" ], "path": "x-pack/plugins/observability/public/plugin.ts", "deprecated": false @@ -3688,6 +3572,19 @@ "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", "deprecated": false }, + { + "parentPluginId": "observability", + "id": "def-public.SeriesConfig.textDefinitionFields", + "type": "Array", + "tags": [], + "label": "textDefinitionFields", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "deprecated": false + }, { "parentPluginId": "observability", "id": "def-public.SeriesConfig.metricOptions", @@ -3883,7 +3780,7 @@ "label": "dataType", "description": [], "signature": [ - "\"mobile\" | \"apm\" | \"synthetics\" | \"infra_metrics\" | \"infra_logs\" | \"ux\"" + "\"mobile\" | \"apm\" | \"synthetics\" | \"ux\" | \"infra_logs\" | \"infra_metrics\"" ], "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", "deprecated": false @@ -3902,6 +3799,20 @@ "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", "deprecated": false }, + { + "parentPluginId": "observability", + "id": "def-public.SeriesUrl.textReportDefinitions", + "type": "Object", + "tags": [], + "label": "textReportDefinitions", + "description": [], + "signature": [ + "URLTextReportDefinition", + " | undefined" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "deprecated": false + }, { "parentPluginId": "observability", "id": "def-public.SeriesUrl.selectedMetricField", @@ -4681,7 +4592,7 @@ "label": "ObservabilityFetchDataPlugins", "description": [], "signature": [ - "\"apm\" | \"synthetics\" | \"infra_metrics\" | \"infra_logs\" | \"ux\"" + "\"apm\" | \"synthetics\" | \"ux\" | \"infra_logs\" | \"infra_metrics\"" ], "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", "deprecated": false, @@ -4991,7 +4902,17 @@ "section": "def-public.AllSeries", "text": "AllSeries" }, - "; }, baseHref?: string, appId?: string) => string; ExploratoryViewEmbeddable: (props: ", + "; }, baseHref?: string, appId?: string) => string; getAppDataView: (appId: ", + "AppDataType", + ", indexPattern?: string | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null | undefined>; ExploratoryViewEmbeddable: (props: ", { "pluginId": "observability", "scope": "public", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index c83029e20587ae..5bd4eccae8623d 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 358 | 2 | 355 | 30 | +| 366 | 2 | 363 | 31 | ## Client diff --git a/api_docs/osquery.devdocs.json b/api_docs/osquery.devdocs.json index e46ce01c80e29e..43ce59b764ca8a 100644 --- a/api_docs/osquery.devdocs.json +++ b/api_docs/osquery.devdocs.json @@ -42,6 +42,44 @@ ], "path": "x-pack/plugins/osquery/public/types.ts", "deprecated": false + }, + { + "parentPluginId": "osquery", + "id": "def-public.OsqueryPluginStart.isOsqueryAvailable", + "type": "Function", + "tags": [], + "label": "isOsqueryAvailable", + "description": [], + "signature": [ + "(props: { agentId: string; }) => boolean" + ], + "path": "x-pack/plugins/osquery/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "osquery", + "id": "def-public.OsqueryPluginStart.isOsqueryAvailable.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "path": "x-pack/plugins/osquery/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "osquery", + "id": "def-public.OsqueryPluginStart.isOsqueryAvailable.$1.agentId", + "type": "string", + "tags": [], + "label": "agentId", + "description": [], + "path": "x-pack/plugins/osquery/public/types.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index c23e08e789e91f..b5fb6eb0b4e5f8 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Security asset management](https://github.com/orgs/elastic/teams/securi | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 10 | 0 | 10 | 0 | +| 13 | 0 | 13 | 0 | ## Client diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index fd475352277ed6..074b16f3f28aed 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-03-15 +date: 2022-03-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,21 +12,21 @@ 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 | |--------------|----------|------------------------| -| 221 | 176 | 34 | +| 248 | 181 | 42 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 24101 | 168 | 18338 | 1107 | +| 24620 | 168 | 18747 | 1131 | ## 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) | - | 125 | 0 | 125 | 11 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 127 | 0 | 127 | 10 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 23 | 0 | 19 | 1 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 296 | 0 | 288 | 18 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 301 | 0 | 293 | 21 | | | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 40 | 0 | 40 | 50 | | | [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 | @@ -34,33 +34,34 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 71 | 0 | 58 | 19 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 321 | 2 | 288 | 4 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 28 | 0 | 23 | 0 | -| | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 6 | 0 | 6 | 0 | +| | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 14 | 0 | 14 | 0 | | | [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 | 130 | 0 | 124 | 4 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2370 | 15 | 969 | 33 | +| | [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 | 133 | 0 | 127 | 4 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2374 | 15 | 969 | 33 | | 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 | 98 | 0 | 79 | 1 | -| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 150 | 0 | 148 | 15 | +| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 151 | 0 | 149 | 14 | | | [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. | 3419 | 40 | 2822 | 27 | +| | [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. | 3457 | 40 | 2844 | 27 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Enhanced data plugin. (See src/plugins/data.) Enhances the main data plugin with a search session management UI. Includes a reusable search session indicator component to use in other applications. Exposes routes for managing search sessions. Includes a service that monitors, updates, and cleans up search session saved objects. | 16 | 0 | 16 | 2 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 13 | 0 | 7 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 42 | 0 | 37 | 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. | 765 | 3 | 616 | 10 | +| | [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. | 863 | 3 | 711 | 15 | | | [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. | 23 | 2 | 19 | 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. | 77 | 0 | 61 | 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 | 471 | 0 | 384 | 5 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 474 | 0 | 385 | 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. | 48 | 0 | 44 | 0 | | | [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 2 | 0 | 2 | 0 | -| | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 110 | 3 | 106 | 3 | +| | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 112 | 3 | 108 | 3 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | The Event Annotation service contains expressions for event annotations | 49 | 0 | 49 | 3 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 91 | 0 | 91 | 9 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'error' renderer to expressions | 17 | 0 | 15 | 2 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart. | 70 | 0 | 70 | 2 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 118 | 0 | 114 | 3 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 119 | 0 | 115 | 3 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'image' function and renderer to expressions | 26 | 0 | 26 | 0 | | | [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) | Expression MetricVis plugin adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 46 | 0 | 46 | 1 | @@ -69,11 +70,11 @@ 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 '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 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2079 | 17 | 1632 | 4 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 222 | 0 | 98 | 2 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2145 | 17 | 1701 | 6 | +| | [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 | 286 | 6 | 247 | 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) | - | 1367 | 8 | 1250 | 9 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1371 | 8 | 1254 | 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 | @@ -91,54 +92,54 @@ 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) | - | 239 | 0 | 203 | 5 | | 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 | -| | [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. | 395 | 0 | 343 | 43 | +| | [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. | 438 | 0 | 363 | 44 | | | [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 | 162 | 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) | - | 216 | 0 | 215 | 27 | +| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 220 | 0 | 219 | 27 | | | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 67 | 0 | 67 | 0 | | | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 4 | 0 | 4 | 1 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 196 | 8 | 79 | 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) | - | 5 | 0 | 5 | 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) | - | 358 | 2 | 355 | 30 | -| | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 10 | 0 | 10 | 0 | +| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 366 | 2 | 363 | 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). | 228 | 2 | 177 | 11 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 4 | 0 | 4 | 0 | | | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Reporting Services enables applications to feature reports that the user can automate with Watcher and download later. | 36 | 0 | 16 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 21 | 0 | 21 | 0 | -| | [RAC](https://github.com/orgs/elastic/teams/rac) | - | 189 | 0 | 162 | 8 | +| | [RAC](https://github.com/orgs/elastic/teams/rac) | - | 191 | 0 | 164 | 8 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 24 | 0 | 19 | 2 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 192 | 2 | 151 | 5 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 103 | 0 | 90 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 54 | 0 | 50 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 90 | 0 | 45 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 33 | 0 | 14 | 0 | -| | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 18 | 0 | 8 | 5 | +| | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 24 | 0 | 12 | 5 | | 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. | 183 | 0 | 103 | 0 | | | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 45 | 0 | 45 | 18 | | sessionView | [Security Team](https://github.com/orgs/elastic/teams/security-team) | - | 0 | 0 | 0 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds URL Service and sharing capabilities to Kibana | 113 | 0 | 54 | 10 | -| | [Shared UX](https://github.com/orgs/elastic/teams/shared-ux) | A plugin providing components and services for shared user experiences in Kibana. | 14 | 0 | 0 | 1 | +| | [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 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 21 | 1 | 21 | 1 | -| | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 256 | 0 | 63 | 0 | +| | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 259 | 0 | 64 | 0 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 4 | 0 | 4 | 0 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 71 | 0 | 33 | 7 | -| | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 41 | 0 | 0 | 0 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 77 | 0 | 39 | 7 | +| | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 43 | 0 | 1 | 0 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 32 | 0 | 32 | 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 | | | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 435 | 1 | 331 | 35 | | | [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) | - | 254 | 0 | 242 | 22 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 300 | 0 | 286 | 22 | | | [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 | 203 | 0 | 141 | 9 | | upgradeAssistant | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | @@ -147,7 +148,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 12 | 0 | 12 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 58 | 0 | 15 | 1 | | | [Uptime](https://github.com/orgs/elastic/teams/uptime) | - | 2 | 0 | 2 | 0 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | The default editor used in most aggregation-based visualizations. | 57 | 0 | 50 | 3 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | The default editor used in most aggregation-based visualizations. | 59 | 0 | 52 | 3 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the gauge chart implementation using the elastic-charts library. The goal is to eventually deprecate the old implementation and keep only this. Until then, the library used is defined by the Legacy charts library advanced setting. | 7 | 0 | 7 | 2 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the heatmap implementation using the elastic-charts library. The goal is to eventually deprecate the old implementation and keep only this. Until then, the library used is defined by the Legacy heatmap charts library advanced setting. | 3 | 0 | 3 | 2 | | visTypeMarkdown | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds a markdown visualization type | 0 | 0 | 0 | 0 | @@ -160,7 +161,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Registers the vega visualization. Is the elastic version of vega and vega-lite libraries. | 2 | 0 | 2 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and heatmap charts. We want to replace them with elastic-charts. | 26 | 0 | 25 | 1 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the new xy-axis chart using the elastic-charts library, which will eventually replace the vislib xy-axis charts including bar, area, and line. | 57 | 0 | 51 | 5 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 361 | 12 | 340 | 14 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 363 | 12 | 342 | 14 | | watcher | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | ## Package Directory @@ -174,16 +175,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | Ahmad Bamieh ahmadbamieh@gmail.com | Kibana Analytics tool | 69 | 0 | 69 | 2 | | | [Owner missing] | - | 16 | 0 | 16 | 0 | | | [Owner missing] | - | 11 | 0 | 11 | 0 | -| | [Owner missing] | - | 11 | 0 | 5 | 1 | +| | [Owner missing] | - | 12 | 0 | 5 | 1 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | | | [Owner missing] | - | 66 | 0 | 46 | 2 | | | [Owner missing] | - | 125 | 3 | 123 | 17 | | | [Owner missing] | - | 13 | 0 | 7 | 0 | | | [Owner missing] | - | 286 | 3 | 207 | 1 | -| | [Owner missing] | - | 62 | 0 | 62 | 2 | +| | [Owner missing] | - | 63 | 0 | 63 | 2 | | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | - | 27 | 0 | 14 | 1 | -| | [Owner missing] | - | 211 | 1 | 159 | 11 | +| | [Owner missing] | - | 213 | 1 | 159 | 11 | | | [Owner missing] | - | 20 | 0 | 16 | 0 | | | [Owner missing] | - | 1 | 0 | 0 | 0 | | | [Owner missing] | - | 51 | 0 | 48 | 0 | @@ -203,18 +204,22 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [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 utilities for React hooks | 14 | 0 | 6 | 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 | 460 | 1 | 448 | 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 | 48 | 0 | 26 | 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 | | | [Owner missing] | Security solution list ReactJS hooks | 56 | 0 | 44 | 0 | -| | [Owner missing] | security solution list utilities | 231 | 0 | 183 | 0 | +| | [Owner missing] | security solution list utilities | 226 | 0 | 178 | 0 | | | [Owner missing] | security solution rule utilities to use across plugins | 23 | 0 | 21 | 0 | | | [Owner missing] | security solution t-grid packages will allow sharing components between timelines and security_solution plugin until we transfer all functionality to timelines plugin | 120 | 0 | 116 | 0 | -| | [Owner missing] | security solution utilities to use across plugins such lists, security_solution, cases, etc... | 28 | 0 | 26 | 0 | +| | [Owner missing] | security solution utilities to use across plugins such lists, security_solution, cases, etc... | 31 | 0 | 29 | 0 | | | [Owner missing] | - | 53 | 0 | 50 | 1 | | | [Owner missing] | - | 25 | 0 | 24 | 1 | +| | [Owner missing] | - | 28 | 0 | 4 | 3 | +| | [Owner missing] | - | 67 | 0 | 43 | 0 | +| | [Owner missing] | - | 10 | 0 | 2 | 0 | +| | [Owner missing] | - | 9 | 0 | 3 | 0 | | | [Owner missing] | - | 96 | 1 | 63 | 2 | | | Operations | - | 22 | 2 | 21 | 0 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 8ebe67f2f956bb..4691da30a8ce67 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-03-15 +date: 2022-03-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 172b83224345dd..b171535c6cddbe 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-03-15 +date: 2022-03-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 0b4efacba2d98c..a52845024c365e 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-03-15 +date: 2022-03-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 e865bf44b80f0c..234a4b339feb49 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-03-15 +date: 2022-03-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 d686c661579cdc..5e68447c679238 100644 --- a/api_docs/rule_registry.devdocs.json +++ b/api_docs/rule_registry.devdocs.json @@ -1376,7 +1376,9 @@ }, ">) => Promise; id: string; name: string; validate?: { params?: ", "AlertTypeParamsValidator", - " | undefined; } | undefined; cancelAlertsOnRuleTimeout?: boolean | undefined; actionGroups: ", + " | undefined; } | undefined; cancelAlertsOnRuleTimeout?: boolean | undefined; config?: ", + "RuleTypeConfig", + " | undefined; actionGroups: ", { "pluginId": "alerting", "scope": "common", @@ -2484,6 +2486,36 @@ "deprecated": false } ] + }, + { + "parentPluginId": "ruleRegistry", + "id": "def-server.LifecycleAlertServices.getAlertStartedDate", + "type": "Function", + "tags": [], + "label": "getAlertStartedDate", + "description": [], + "signature": [ + "(alertId: string) => string | null" + ], + "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ruleRegistry", + "id": "def-server.LifecycleAlertServices.getAlertStartedDate.$1", + "type": "string", + "tags": [], + "label": "alertId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 21985f094b1ae8..8307927128bb8c 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [RAC](https://github.com/orgs/elastic/teams/rac) for questions regarding | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 189 | 0 | 162 | 8 | +| 191 | 0 | 164 | 8 | ## Server diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 91300db15bb8d9..c625a3279da820 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-03-15 +date: 2022-03-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 976a464e0d9875..91e85dae14f9cc 100644 --- a/api_docs/saved_objects.devdocs.json +++ b/api_docs/saved_objects.devdocs.json @@ -577,6 +577,7 @@ ], "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "embeddable", @@ -1600,6 +1601,7 @@ "description": [], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "savedObjectsTaggingOss", @@ -1696,6 +1698,22 @@ { "plugin": "lens", "path": "x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/check_for_duplicate_title.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/check_for_duplicate_title.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.d.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/target/types/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.d.ts" } ], "children": [ @@ -3166,6 +3184,7 @@ ], "path": "src/plugins/saved_objects/public/plugin.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "dashboard", @@ -3187,6 +3206,7 @@ ], "path": "src/plugins/saved_objects/public/plugin.ts", "deprecated": true, + "removeBy": "8.8.0", "references": [ { "plugin": "visualizations", diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index 8a2a6f5580d79e..878c4ded288689 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-03-15 +date: 2022-03-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.mdx b/api_docs/saved_objects_management.mdx index ddfd6ad386ffd8..e6d074c598a416 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-03-15 +date: 2022-03-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.mdx b/api_docs/saved_objects_tagging.mdx index 10904ca8cd0c33..e8968e608d2fd3 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-03-15 +date: 2022-03-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.mdx b/api_docs/saved_objects_tagging_oss.mdx index f78ee85a89bb05..fb164203bf1002 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-03-15 +date: 2022-03-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 19fc50c00a669e..857f4433fc48dc 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/screenshotting.devdocs.json index 686b42fa6fcfad..fe79cd45375c2b 100644 --- a/api_docs/screenshotting.devdocs.json +++ b/api_docs/screenshotting.devdocs.json @@ -14,60 +14,69 @@ "interfaces": [ { "parentPluginId": "screenshotting", - "id": "def-server.ScreenshotOptions", + "id": "def-server.PdfScreenshotOptions", "type": "Interface", "tags": [], - "label": "ScreenshotOptions", - "description": [], + "label": "PdfScreenshotOptions", + "description": [ + "\nOptions that should be provided to a PDF screenshot request." + ], "signature": [ { "pluginId": "screenshotting", "scope": "server", "docId": "kibScreenshottingPluginApi", - "section": "def-server.ScreenshotOptions", - "text": "ScreenshotOptions" + "section": "def-server.PdfScreenshotOptions", + "text": "PdfScreenshotOptions" }, " extends ", - "ScreenshotObservableOptions" + "ScreenshotOptions", + "<\"pdf\">" ], - "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false, "children": [ { "parentPluginId": "screenshotting", - "id": "def-server.ScreenshotOptions.layout", - "type": "Object", + "id": "def-server.PdfScreenshotOptions.title", + "type": "string", "tags": [], - "label": "layout", + "label": "title", "description": [], "signature": [ - "{ id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", - "LayoutSelectorDictionary", - "> | undefined; zoom?: number | undefined; }" + "string | undefined" ], - "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false }, { "parentPluginId": "screenshotting", - "id": "def-server.ScreenshotOptions.request", + "id": "def-server.PdfScreenshotOptions.logo", + "type": "string", + "tags": [], + "label": "logo", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", + "deprecated": false + }, + { + "parentPluginId": "screenshotting", + "id": "def-server.PdfScreenshotOptions.layout", "type": "Object", "tags": [], - "label": "request", + "label": "layout", "description": [ - "\nSource Kibana request object from where the headers will be extracted." + "\nWe default to the \"print\" layout if no ID is specified for the layout" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined" + "{ id?: \"canvas\" | \"print\" | \"preserve_layout\" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "LayoutSelectorDictionary", + "> | undefined; zoom?: number | undefined; }" ], - "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false } ], @@ -75,60 +84,146 @@ }, { "parentPluginId": "screenshotting", - "id": "def-server.ScreenshotResult", + "id": "def-server.PdfScreenshotResult", "type": "Interface", "tags": [], - "label": "ScreenshotResult", - "description": [], - "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", + "label": "PdfScreenshotResult", + "description": [ + "\nFinal, formatted PDF result" + ], + "signature": [ + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.PdfScreenshotResult", + "text": "PdfScreenshotResult" + }, + " extends Omit<", + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.FormattedScreenshotResult", + "text": "FormattedScreenshotResult" + }, + ", \"results\">" + ], + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false, "children": [ { "parentPluginId": "screenshotting", - "id": "def-server.ScreenshotResult.layout", + "id": "def-server.PdfScreenshotResult.metrics", "type": "CompoundType", "tags": [], - "label": "layout", - "description": [ - "\nUsed layout instance constructed from the given options." - ], + "label": "metrics", + "description": [], "signature": [ - "BaseLayout", - " & LayoutSelectors & Partial<{ width: number; height: number; }>" + "PerformanceMetrics", + " & { pageCount: number; }" ], - "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false }, { "parentPluginId": "screenshotting", - "id": "def-server.ScreenshotResult.metrics", + "id": "def-server.PdfScreenshotResult.result", "type": "Object", "tags": [], - "label": "metrics", - "description": [ - "\nCollected performance metrics during the screenshotting session." - ], + "label": "result", + "description": [], "signature": [ - "PerformanceMetrics", - " | undefined" + "{ data: Buffer; errors: Error[]; renderErrors: string[]; }" ], - "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "screenshotting", + "id": "def-server.PngScreenshotOptions", + "type": "Interface", + "tags": [], + "label": "PngScreenshotOptions", + "description": [ + "\nOptions that should be provided to a screenshot PNG request" + ], + "signature": [ + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.PngScreenshotOptions", + "text": "PngScreenshotOptions" }, + " extends ", + "ScreenshotOptions", + "<\"png\">" + ], + "path": "x-pack/plugins/screenshotting/server/formats/png.ts", + "deprecated": false, + "children": [ { "parentPluginId": "screenshotting", - "id": "def-server.ScreenshotResult.results", - "type": "Array", + "id": "def-server.PngScreenshotOptions.layout", + "type": "Object", "tags": [], - "label": "results", - "description": [ - "\nScreenshotting results." + "label": "layout", + "description": [], + "signature": [ + "{ id?: \"preserve_layout\" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "LayoutSelectorDictionary", + "> | undefined; zoom?: number | undefined; }" ], + "path": "x-pack/plugins/screenshotting/server/formats/png.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "screenshotting", + "id": "def-server.PngScreenshotResult", + "type": "Interface", + "tags": [], + "label": "PngScreenshotResult", + "description": [ + "\nThe final output of a PNG screenshot" + ], + "signature": [ + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.PngScreenshotResult", + "text": "PngScreenshotResult" + }, + " extends ", + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.FormattedScreenshotResult", + "text": "FormattedScreenshotResult" + } + ], + "path": "x-pack/plugins/screenshotting/server/formats/png.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "screenshotting", + "id": "def-server.PngScreenshotResult.metadata", + "type": "Uncategorized", + "tags": [], + "label": "metadata", + "description": [], "signature": [ - "ScreenshotObservableResult", - "[]" + "undefined" ], - "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", + "path": "x-pack/plugins/screenshotting/server/formats/png.ts", "deprecated": false } ], @@ -137,6 +232,26 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "screenshotting", + "id": "def-server.FormattedScreenshotResult", + "type": "Type", + "tags": [], + "label": "FormattedScreenshotResult", + "description": [ + "\nA general, overridable type of screenshot result\n\nPDF or PNG screenshots should extend this and convert the output to a type\nthat best suits their use cases.\n\nThis type documents what might appear on any given output type" + ], + "signature": [ + "{ metrics?: ", + "PerformanceMetrics", + " | undefined; results: ", + "ScreenshotObservableResult", + "[]; }" + ], + "path": "x-pack/plugins/screenshotting/server/formats/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "screenshotting", "id": "def-server.Layout", @@ -151,6 +266,20 @@ "path": "x-pack/plugins/screenshotting/server/layouts/index.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "screenshotting", + "id": "def-server.UrlOrUrlWithContext", + "type": "Type", + "tags": [], + "label": "UrlOrUrlWithContext", + "description": [], + "signature": [ + "string | UrlWithContext" + ], + "path": "x-pack/plugins/screenshotting/server/screenshots/observable.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [], @@ -211,53 +340,64 @@ "\nTakes screenshots of multiple pages." ], "signature": [ - "(options: ", + " ", + " | ", + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.PngScreenshotOptions", + "text": "PngScreenshotOptions" + }, + ">(options: O) => ", "Observable", - "<", + "" ], "path": "x-pack/plugins/screenshotting/server/plugin.ts", "deprecated": false, - "returnComment": [ - "Observable with screenshotting results." - ], "children": [ { "parentPluginId": "screenshotting", "id": "def-server.ScreenshottingStart.getScreenshots.$1", - "type": "Object", + "type": "Uncategorized", "tags": [], "label": "options", "description": [ "Screenshots session options." ], "signature": [ - { - "pluginId": "screenshotting", - "scope": "server", - "docId": "kibScreenshottingPluginApi", - "section": "def-server.ScreenshotOptions", - "text": "ScreenshotOptions" - } + "O" ], - "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", - "deprecated": false + "path": "x-pack/plugins/screenshotting/server/plugin.ts", + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "Observable with screenshotting results." ] } ], @@ -281,9 +421,15 @@ "\nScreenshot layout parameters." ], "signature": [ - "{ id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "{ id?: ID | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "LayoutSelectorDictionary", + "> | undefined; zoom?: number | undefined; } extends ", + "SerializableRecord", + " ? ", + "SerializableRecord", + " & { id?: ID | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", - "> | undefined; zoom?: number | undefined; }" + "> | undefined; zoom?: number | undefined; } : never" ], "path": "x-pack/plugins/screenshotting/common/layout.ts", "deprecated": false, @@ -310,6 +456,9 @@ "tags": [], "label": "PRESERVE_LAYOUT", "description": [], + "signature": [ + "\"preserve_layout\"" + ], "path": "x-pack/plugins/screenshotting/common/layout.ts", "deprecated": false }, @@ -320,6 +469,9 @@ "tags": [], "label": "PRINT", "description": [], + "signature": [ + "\"print\"" + ], "path": "x-pack/plugins/screenshotting/common/layout.ts", "deprecated": false }, @@ -330,6 +482,9 @@ "tags": [], "label": "CANVAS", "description": [], + "signature": [ + "\"canvas\"" + ], "path": "x-pack/plugins/screenshotting/common/layout.ts", "deprecated": false } diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index c6382079375f3d..bdfe8f9e3a3fd6 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 18 | 0 | 8 | 5 | +| 24 | 0 | 12 | 5 | ## Server diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 75510a73fe6c53..3e9f3bdb1286b1 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index 21a9c7aa218362..706ef53c378e99 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -62,7 +62,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly metricsEntitiesEnabled: boolean; readonly ruleRegistryEnabled: boolean; readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly usersEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly securityRulesCancelEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; }" + "{ readonly metricsEntitiesEnabled: boolean; readonly ruleRegistryEnabled: boolean; readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly usersEnabled: boolean; readonly detectionResponseEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly securityRulesCancelEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; }" ], "path": "x-pack/plugins/security_solution/public/plugin.tsx", "deprecated": false @@ -887,7 +887,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<{ metricsEntitiesEnabled: boolean; ruleRegistryEnabled: boolean; tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; usersEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; securityRulesCancelEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; previewTelemetryUrlEnabled: 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<{ metricsEntitiesEnabled: boolean; ruleRegistryEnabled: boolean; tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; usersEnabled: boolean; detectionResponseEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; securityRulesCancelEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: 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 51f4c27031529d..49d1378275f3f2 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-03-15 +date: 2022-03-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. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index d655e7f08a1d30..c37fd16141ceaa 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/shared_u_x.devdocs.json index dbcd1b5d825c59..948d6b212ebf87 100644 --- a/api_docs/shared_u_x.devdocs.json +++ b/api_docs/shared_u_x.devdocs.json @@ -2,148 +2,7 @@ "id": "sharedUX", "client": { "classes": [], - "functions": [ - { - "parentPluginId": "sharedUX", - "id": "def-public.ExitFullScreenButton", - "type": "Function", - "tags": [], - "label": "ExitFullScreenButton", - "description": [ - "\nA `ExitFullScreenButton` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LazyExitFullScreenButton` component lazily with\na predefined fallback and error boundary." - ], - "signature": [ - "React.ForwardRefExoticComponent<", - "Props", - " & React.RefAttributes<{}>>" - ], - "path": "src/plugins/shared_ux/public/components/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "sharedUX", - "id": "def-public.ExitFullScreenButton.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "sharedUX", - "id": "def-public.LazyExitFullScreenButton", - "type": "Function", - "tags": [], - "label": "LazyExitFullScreenButton", - "description": [ - "\nThe Lazily-loaded `ExitFullScreenButton` component. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." - ], - "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ onExit, toggleChrome }: ", - "Props", - ") => JSX.Element; }" - ], - "path": "src/plugins/shared_ux/public/components/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "sharedUX", - "id": "def-public.LazyExitFullScreenButton.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "sharedUX", - "id": "def-public.LazyNoDataViewsPage", - "type": "Function", - "tags": [], - "label": "LazyNoDataViewsPage", - "description": [ - "\nThe Lazily-loaded `NoDataViews` component. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." - ], - "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ onDataViewCreated, dataViewsDocLink }: ", - "Props", - ") => JSX.Element; }" - ], - "path": "src/plugins/shared_ux/public/components/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "sharedUX", - "id": "def-public.LazyNoDataViewsPage.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "sharedUX", - "id": "def-public.NoDataViewsPage", - "type": "Function", - "tags": [], - "label": "NoDataViewsPage", - "description": [ - "\nA `NoDataViewsPage` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LazyNoDataViewsPage` component lazily with\na predefined fallback and error boundary." - ], - "signature": [ - "React.ForwardRefExoticComponent<", - "Props", - " & React.RefAttributes<{}>>" - ], - "path": "src/plugins/shared_ux/public/components/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "sharedUX", - "id": "def-public.NoDataViewsPage.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], + "functions": [], "interfaces": [], "enums": [], "misc": [], @@ -162,47 +21,21 @@ "children": [ { "parentPluginId": "sharedUX", - "id": "def-public.SharedUXPluginStart.ServicesContext", + "id": "def-public.SharedUXPluginStart.getContextServices", "type": "Function", "tags": [], - "label": "ServicesContext", + "label": "getContextServices", "description": [ - "\nA React component that provides a pre-wired `React.Context` which connects components to Shared UX services." + "\nA set of pre-wired services for use with `SharedUxServicesProvider`.\n\n```\nimport { SharedUxServicesProvider } from '@kbn/shared-ux-services';\n\npublic start(coreStart: CoreStart, startPlugins: MyPluginStartDeps): MyPluginStart {\n const services = startPlugins.sharedUX.getContextServices();\n return {\n ServicesContext: ({ children }) => {children},\n };\n}\n```\n\nor\n\n```\nimport { SharedUxServicesProvider } from '@kbn/shared-ux-services';\n\npublic setup(coreSetup: CoreSetup, setupPlugins: MyPluginSetupDeps): MyPluginSetup {\n const [coreStart, startPlugins] = await coreSetup.getStartServices();\n coreSetup.application.register({\n mount: async (params: AppMountParameters) => {\n ReactDOM.render(\n \n \n ,\n params.element\n );\n }\n );\n}\n```" ], "signature": [ - "React.FunctionComponent<{}>" + "() => ", + "SharedUxServices" ], "path": "src/plugins/shared_ux/public/types/index.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "sharedUX", - "id": "def-public.SharedUXPluginStart.ServicesContext.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P & { children?: React.ReactNode; }" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "sharedUX", - "id": "def-public.SharedUXPluginStart.ServicesContext.$2", - "type": "Any", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "any" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ] + "children": [], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index 4da4b7a356cef6..7646bb835d30f5 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-03-15 +date: 2022-03-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. --- @@ -18,16 +18,13 @@ Contact [Shared UX](https://github.com/orgs/elastic/teams/shared-ux) for questio | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 14 | 0 | 0 | 1 | +| 4 | 0 | 0 | 0 | ## Client ### Start -### Functions - - ## Common ### Consts, variables and types diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index 6cfe040b28e67e..25cf5d3b0cf565 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-03-15 +date: 2022-03-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 3d1f4cd9ee2604..2474be31bef20b 100644 --- a/api_docs/spaces.devdocs.json +++ b/api_docs/spaces.devdocs.json @@ -1180,6 +1180,63 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "spaces", + "id": "def-public.RedirectLegacyUrlParams", + "type": "Interface", + "tags": [], + "label": "RedirectLegacyUrlParams", + "description": [ + "\nParameters for the redirectLegacyUrl function." + ], + "path": "x-pack/plugins/spaces/public/legacy_urls/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "spaces", + "id": "def-public.RedirectLegacyUrlParams.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe path to use for the new URL, optionally including `search` and/or `hash` URL components." + ], + "path": "x-pack/plugins/spaces/public/legacy_urls/types.ts", + "deprecated": false + }, + { + "parentPluginId": "spaces", + "id": "def-public.RedirectLegacyUrlParams.aliasPurpose", + "type": "CompoundType", + "tags": [], + "label": "aliasPurpose", + "description": [ + "\nThe reason the resolved alias was created.\n\nThis 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\nbecause of saved object conversion, then we will display a toast telling the user that the object has a new URL." + ], + "signature": [ + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + ], + "path": "x-pack/plugins/spaces/public/legacy_urls/types.ts", + "deprecated": false + }, + { + "parentPluginId": "spaces", + "id": "def-public.RedirectLegacyUrlParams.objectNoun", + "type": "string", + "tags": [], + "label": "objectNoun", + "description": [ + "\nThe string that is used to describe the object in the toast, e.g., _The **object** you're looking for has a new location_.\nDefault value is 'object'." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/spaces/public/legacy_urls/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "spaces", "id": "def-public.ShareToSpaceFlyoutProps", @@ -1916,10 +1973,18 @@ "tags": [], "label": "redirectLegacyUrl", "description": [ - "\nRedirect the user from a legacy URL to a new URL. This needs to be used if a call to `SavedObjectsClient.resolve()` results in an\n`\"aliasMatch\"` outcome, which indicates that the user has loaded the page using a legacy URL. Calling this function will trigger a\nclient-side redirect to the new URL, and it will display a toast to the user.\n\nConsumers need to determine the local path for the new URL on their own, based on the object ID that was used to call\n`SavedObjectsClient.resolve()` (old ID) and the object ID in the result (new ID). For example...\n\nThe old object ID is `workpad-123` and the new object ID is `workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e`.\n\nFull legacy URL: `https://localhost:5601/app/canvas#/workpad/workpad-123/page/1`\n\nNew URL path: `#/workpad/workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e/page/1`\n\nThe protocol, hostname, port, base path, and app path are automatically included.\n" + "\nRedirect the user from a legacy URL to a new URL. This needs to be used if a call to `SavedObjectsClient.resolve()` results in an\n`\"aliasMatch\"` outcome, which indicates that the user has loaded the page using a legacy URL. Calling this function will trigger a\nclient-side redirect to the new URL, and it will display a toast to the user.\n\nConsumers need to determine the local path for the new URL on their own, based on the object ID that was used to call\n`SavedObjectsClient.resolve()` (old ID) and the object ID in the result (new ID). For example...\n\nThe old object ID is `workpad-123` and the new object ID is `workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e`.\n\nFull legacy URL: `https://localhost:5601/app/canvas#/workpad/workpad-123/page/1`\n\nNew URL path: `#/workpad/workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e/page/1`\n\nThe protocol, hostname, port, base path, and app path are automatically included." ], "signature": [ - "(path: string, objectNoun?: string | undefined) => Promise" + "(params: ", + { + "pluginId": "spaces", + "scope": "public", + "docId": "kibSpacesPluginApi", + "section": "def-public.RedirectLegacyUrlParams", + "text": "RedirectLegacyUrlParams" + }, + ") => Promise" ], "path": "x-pack/plugins/spaces/public/ui_api/types.ts", "deprecated": false, @@ -1927,34 +1992,22 @@ { "parentPluginId": "spaces", "id": "def-public.SpacesApiUi.redirectLegacyUrl.$1", - "type": "string", + "type": "Object", "tags": [], - "label": "path", - "description": [ - "The path to use for the new URL, optionally including `search` and/or `hash` URL components." - ], + "label": "params", + "description": [], "signature": [ - "string" + { + "pluginId": "spaces", + "scope": "public", + "docId": "kibSpacesPluginApi", + "section": "def-public.RedirectLegacyUrlParams", + "text": "RedirectLegacyUrlParams" + } ], "path": "x-pack/plugins/spaces/public/ui_api/types.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "spaces", - "id": "def-public.SpacesApiUi.redirectLegacyUrl.$2", - "type": "string", - "tags": [], - "label": "objectNoun", - "description": [ - "The string that is used to describe the object in the toast, e.g., _The **object** you're looking for has a new\nlocation_. Default value is 'object'." - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/spaces/public/ui_api/types.ts", - "deprecated": false, - "isRequired": false } ], "returnComment": [] diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index 9ec06434b6df91..34612eea433967 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-03-15 +date: 2022-03-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. --- @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 256 | 0 | 63 | 0 | +| 259 | 0 | 64 | 0 | ## Client diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index 4b1945020f4254..121383562c4982 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/task_manager.devdocs.json index 791fb94b6ffacd..2782bb48ff8573 100644 --- a/api_docs/task_manager.devdocs.json +++ b/api_docs/task_manager.devdocs.json @@ -1130,7 +1130,84 @@ "initialIsOpen": false } ], - "objects": [], + "objects": [ + { + "parentPluginId": "taskManager", + "id": "def-server.IdleTaskWithExpiredRunAt", + "type": "Object", + "tags": [], + "label": "IdleTaskWithExpiredRunAt", + "description": [], + "path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.IdleTaskWithExpiredRunAt.bool", + "type": "Object", + "tags": [], + "label": "bool", + "description": [], + "path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.IdleTaskWithExpiredRunAt.bool.must", + "type": "Array", + "tags": [], + "label": "must", + "description": [], + "signature": [ + "({ term: { 'task.status': string; }; } | { range: { 'task.runAt': { lte: string; }; }; })[]" + ], + "path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "taskManager", + "id": "def-server.RunningOrClaimingTaskWithExpiredRetryAt", + "type": "Object", + "tags": [], + "label": "RunningOrClaimingTaskWithExpiredRetryAt", + "description": [], + "path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.RunningOrClaimingTaskWithExpiredRetryAt.bool", + "type": "Object", + "tags": [], + "label": "bool", + "description": [], + "path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.RunningOrClaimingTaskWithExpiredRetryAt.bool.must", + "type": "Array", + "tags": [], + "label": "must", + "description": [], + "signature": [ + "({ bool: { should: { term: { 'task.status': string; }; }[]; }; } | { range: { 'task.retryAt': { lte: string; }; }; })[]" + ], + "path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ], "setup": { "parentPluginId": "taskManager", "id": "def-server.TaskManagerSetupContract", diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index 9e8058aab1bf71..d25c4da817e6fe 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-03-15 +date: 2022-03-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. --- @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 71 | 0 | 33 | 7 | +| 77 | 0 | 39 | 7 | ## Server @@ -28,6 +28,9 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q ### Start +### Objects + + ### Functions diff --git a/api_docs/telemetry.devdocs.json b/api_docs/telemetry.devdocs.json index f11cd70523645d..33ac6a757d48f7 100644 --- a/api_docs/telemetry.devdocs.json +++ b/api_docs/telemetry.devdocs.json @@ -4,6 +4,38 @@ "classes": [], "functions": [], "interfaces": [ + { + "parentPluginId": "telemetry", + "id": "def-public.TelemetryConstants", + "type": "Interface", + "tags": [], + "label": "TelemetryConstants", + "description": [ + "\nPublic's start exposed APIs by the telemetry plugin" + ], + "path": "src/plugins/telemetry/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "telemetry", + "id": "def-public.TelemetryConstants.getPrivacyStatementUrl", + "type": "Function", + "tags": [], + "label": "getPrivacyStatementUrl", + "description": [ + "Elastic's privacy statement url" + ], + "signature": [ + "() => string" + ], + "path": "src/plugins/telemetry/public/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "telemetry", "id": "def-public.TelemetryPluginConfig", @@ -269,9 +301,7 @@ "type": "Interface", "tags": [], "label": "TelemetryPluginStart", - "description": [ - "\nPublic's start exposed APIs by the telemetry plugin" - ], + "description": [], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, "children": [ @@ -321,7 +351,13 @@ "Set of publicly exposed telemetry constants" ], "signature": [ - "{ getPrivacyStatementUrl: () => string; }" + { + "pluginId": "telemetry", + "scope": "public", + "docId": "kibTelemetryPluginApi", + "section": "def-public.TelemetryConstants", + "text": "TelemetryConstants" + } ], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 9f2bf68b728bbd..416652d7757e39 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-03-15 +date: 2022-03-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. --- @@ -18,7 +18,7 @@ Contact [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetr | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 41 | 0 | 0 | 0 | +| 43 | 0 | 1 | 0 | ## Client diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 9ac19c1156fb5b..9cb2118638de7c 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-03-15 +date: 2022-03-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 97bd93a1b481b7..63e017a0ecba93 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-03-15 +date: 2022-03-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 05fefbb5efd327..a3b33a115f5769 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-03-15 +date: 2022-03-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/timelines.mdx b/api_docs/timelines.mdx index 95127f842b366c..2d10c70b8c02bf 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-03-15 +date: 2022-03-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 ecce2a27fc8e99..37168131c88ebf 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-03-15 +date: 2022-03-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 4f6ad8125e34c5..121f164fb040d5 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -46,6 +46,19 @@ "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.Plugin.experimentalFeatures", + "type": "Object", + "tags": [], + "label": "experimentalFeatures", + "description": [], + "signature": [ + "{ readonly rulesListDatagrid: boolean; readonly rulesDetailLogs: boolean; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.Plugin.Unnamed", @@ -58,7 +71,29 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.Plugin.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "ctx", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { @@ -341,6 +376,207 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.deleteRules", + "type": "Function", + "tags": [], + "label": "deleteRules", + "description": [], + "signature": [ + "({\n ids,\n http,\n}: { ids: string[]; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise<{ successes: string[]; errors: string[]; }>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/delete.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.deleteRules.$1", + "type": "Object", + "tags": [], + "label": "{\n ids,\n http,\n}", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/delete.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.deleteRules.$1.ids", + "type": "Array", + "tags": [], + "label": "ids", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/delete.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.deleteRules.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/delete.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.disableRule", + "type": "Function", + "tags": [], + "label": "disableRule", + "description": [], + "signature": [ + "({ id, http }: { id: string; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/disable.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.disableRule.$1", + "type": "Object", + "tags": [], + "label": "{ id, http }", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/disable.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.disableRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/disable.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.disableRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/disable.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.enableRule", + "type": "Function", + "tags": [], + "label": "enableRule", + "description": [], + "signature": [ + "({ id, http }: { id: string; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/enable.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.enableRule.$1", + "type": "Object", + "tags": [], + "label": "{ id, http }", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/enable.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.enableRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/enable.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.enableRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/enable.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.ForLastExpression", @@ -989,6 +1225,72 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.muteRule", + "type": "Function", + "tags": [], + "label": "muteRule", + "description": [], + "signature": [ + "({ id, http }: { id: string; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.muteRule.$1", + "type": "Object", + "tags": [], + "label": "{ id, http }", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.muteRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.muteRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.OfExpression", @@ -1053,6 +1355,119 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unmuteRule", + "type": "Function", + "tags": [], + "label": "unmuteRule", + "description": [], + "signature": [ + "({ id, http }: { id: string; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unmuteRule.$1", + "type": "Object", + "tags": [], + "label": "{ id, http }", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unmuteRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unmuteRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.useLoadRuleTypes", + "type": "Function", + "tags": [], + "label": "useLoadRuleTypes", + "description": [], + "signature": [ + "({ filteredSolutions }: RuleTypesProps) => { ruleTypes: ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleType", + "text": "RuleType" + }, + "[]; error: string | null; ruleTypeIndex: ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleTypeIndex", + "text": "RuleTypeIndex" + }, + "; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/hooks/use_load_rule_types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.useLoadRuleTypes.$1", + "type": "Object", + "tags": [], + "label": "{ filteredSolutions }", + "description": [], + "signature": [ + "RuleTypesProps" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/hooks/use_load_rule_types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.ValueExpression", @@ -1319,88 +1734,259 @@ "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.Comparator.text", + "id": "def-public.Comparator.text", + "type": "string", + "tags": [], + "label": "text", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.Comparator.value", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.Comparator.requiredValues", + "type": "number", + "tags": [], + "label": "requiredValues", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.GroupByType", + "type": "Interface", + "tags": [], + "label": "GroupByType", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.GroupByType.text", + "type": "string", + "tags": [], + "label": "text", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.GroupByType.sizeRequired", + "type": "boolean", + "tags": [], + "label": "sizeRequired", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.GroupByType.value", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.GroupByType.validNormalizedTypes", + "type": "Array", + "tags": [], + "label": "validNormalizedTypes", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.IErrorObject", + "type": "Interface", + "tags": [], + "label": "IErrorObject", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.IErrorObject.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: string | string[] | IErrorObject", + "description": [], + "signature": [ + "[key: string]: string | string[] | ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.IErrorObject", + "text": "IErrorObject" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.IOption", + "type": "Interface", + "tags": [], + "label": "IOption", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.IOption.label", + "type": "string", + "tags": [], + "label": "label", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.IOption.options", + "type": "Array", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{ value: string; label: string; }[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.RuleTableItem", + "type": "Interface", + "tags": [], + "label": "RuleTableItem", + "description": [], + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleTableItem", + "text": "RuleTableItem" + }, + " extends ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.Rule", + "text": "Rule" + }, + "<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertTypeParams", + "text": "AlertTypeParams" + }, + ">" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.RuleTableItem.ruleType", "type": "string", "tags": [], - "label": "text", + "label": "ruleType", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.Comparator.value", - "type": "string", + "id": "def-public.RuleTableItem.index", + "type": "number", "tags": [], - "label": "value", + "label": "index", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.Comparator.requiredValues", + "id": "def-public.RuleTableItem.actionsCount", "type": "number", "tags": [], - "label": "requiredValues", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType", - "type": "Interface", - "tags": [], - "label": "GroupByType", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType.text", - "type": "string", - "tags": [], - "label": "text", + "label": "actionsCount", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType.sizeRequired", + "id": "def-public.RuleTableItem.isEditable", "type": "boolean", "tags": [], - "label": "sizeRequired", + "label": "isEditable", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType.value", - "type": "string", + "id": "def-public.RuleTableItem.enabledInLicense", + "type": "boolean", "tags": [], - "label": "value", + "label": "enabledInLicense", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType.validNormalizedTypes", - "type": "Array", + "id": "def-public.RuleTableItem.showIntervalWarning", + "type": "CompoundType", "tags": [], - "label": "validNormalizedTypes", + "label": "showIntervalWarning", "description": [], "signature": [ - "string[]" + "boolean | undefined" ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false } ], @@ -1408,68 +1994,66 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.IErrorObject", + "id": "def-public.RuleType", "type": "Interface", "tags": [], - "label": "IErrorObject", + "label": "RuleType", "description": [], + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleType", + "text": "RuleType" + }, + " extends Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleType", + "text": "RuleType" + }, + ", \"id\" | \"name\" | \"actionGroups\" | \"defaultActionGroupId\" | \"recoveryActionGroup\" | \"producer\" | \"minimumLicenseRequired\" | \"defaultScheduleInterval\" | \"ruleTaskTimeout\" | \"doesSetRecoveryContext\">" + ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.IErrorObject.Unnamed", - "type": "IndexSignature", + "id": "def-public.RuleType.actionVariables", + "type": "CompoundType", "tags": [], - "label": "[key: string]: string | string[] | IErrorObject", + "label": "actionVariables", "description": [], "signature": [ - "[key: string]: string | string[] | ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.IErrorObject", - "text": "IErrorObject" - } + "AsActionVariables<\"params\"> & Partial>" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.IOption", - "type": "Interface", - "tags": [], - "label": "IOption", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.IOption.label", - "type": "string", + "id": "def-public.RuleType.authorizedConsumers", + "type": "Object", "tags": [], - "label": "label", + "label": "authorizedConsumers", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", + "signature": [ + "{ [x: string]: { read: boolean; all: boolean; }; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.IOption.options", - "type": "Array", + "id": "def-public.RuleType.enabledInLicense", + "type": "boolean", "tags": [], - "label": "options", + "label": "enabledInLicense", "description": [], - "signature": [ - "{ value: string; label: string; }[]" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false } ], @@ -1764,7 +2348,7 @@ "label": "setRuleProperty", "description": [], "signature": [ - "(key: Prop, value: ", + "(key: Prop, value: ", "SanitizedRule", "[Prop] | null) => void" ], @@ -2445,6 +3029,28 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.RuleTypeIndex", + "type": "Type", + "tags": [], + "label": "RuleTypeIndex", + "description": [], + "signature": [ + "Map>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.RuleTypeRegistryContract", @@ -3890,7 +4496,121 @@ }, "common": { "classes": [], - "functions": [], + "functions": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.getExperimentalAllowedValues", + "type": "Function", + "tags": [], + "label": "getExperimentalAllowedValues", + "description": [], + "signature": [ + "() => string[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.isValidExperimentalValue", + "type": "Function", + "tags": [], + "label": "isValidExperimentalValue", + "description": [], + "signature": [ + "(value: string) => boolean" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.isValidExperimentalValue.$1", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.parseExperimentalConfigValue", + "type": "Function", + "tags": [ + "throws" + ], + "label": "parseExperimentalConfigValue", + "description": [ + "\nParses the string value used in `xpack.triggersActionsUi.enableExperimental` kibana configuration,\nwhich should be a string of values delimited by a comma (`,`)\n" + ], + "signature": [ + "(configValue: string[]) => Readonly<{ rulesListDatagrid: boolean; rulesDetailLogs: boolean; }>" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.parseExperimentalConfigValue.$1", + "type": "Array", + "tags": [], + "label": "configValue", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.parseInterval", + "type": "Function", + "tags": [], + "label": "parseInterval", + "description": [], + "signature": [ + "(intervalString: string) => { value: number; unit: string; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/parse_interval.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.parseInterval.$1", + "type": "string", + "tags": [], + "label": "intervalString", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/parse_interval.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], "interfaces": [ { "parentPluginId": "triggersActionsUi", @@ -3985,6 +4705,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.ExperimentalFeatures", + "type": "Type", + "tags": [], + "label": "ExperimentalFeatures", + "description": [], + "signature": [ + "{ readonly rulesListDatagrid: boolean; readonly rulesDetailLogs: boolean; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-common.MetricResult", @@ -4000,6 +4734,37 @@ "initialIsOpen": false } ], - "objects": [] + "objects": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.allowedExperimentalValues", + "type": "Object", + "tags": [], + "label": "allowedExperimentalValues", + "description": [ + "\nA list of allowed values that can be used in `xpack.triggersActionsUi.enableExperimental`.\nThis object is then used to validate and parse the value entered." + ], + "signature": [ + "{ readonly rulesListDatagrid: boolean; readonly rulesDetailLogs: boolean; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.INTERVAL_STRING_RE", + "type": "Object", + "tags": [], + "label": "INTERVAL_STRING_RE", + "description": [], + "signature": [ + "RegExp" + ], + "path": "x-pack/plugins/triggers_actions_ui/common/parse_interval.ts", + "deprecated": false, + "initialIsOpen": false + } + ] } } \ No newline at end of file diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index ca4b28f3644fcf..b8aac1303ac8d4 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-03-15 +date: 2022-03-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 | |-------------------|-----------|------------------------|-----------------| -| 254 | 0 | 242 | 22 | +| 300 | 0 | 286 | 22 | ## Client @@ -62,6 +62,12 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q ## Common +### Objects + + +### Functions + + ### Interfaces diff --git a/api_docs/ui_actions.devdocs.json b/api_docs/ui_actions.devdocs.json index 51c99237e09096..925dfa5a64c1a3 100644 --- a/api_docs/ui_actions.devdocs.json +++ b/api_docs/ui_actions.devdocs.json @@ -685,6 +685,10 @@ { "plugin": "embeddable", "path": "src/plugins/embeddable/public/tests/explicit_input.test.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/target/types/public/embeddable/search_embeddable_factory.d.ts" } ], "children": [ diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index a96aca857757e7..e2a861f53c4d1c 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-03-15 +date: 2022-03-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 9dc29447217c53..48a419e4e2841c 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-03-15 +date: 2022-03-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/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 5fa7035e7f8a2a..775a66736f19d0 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-03-15 +date: 2022-03-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.mdx b/api_docs/usage_collection.mdx index d61831e2db5219..a4c064a44905aa 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-03-15 +date: 2022-03-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 6548986fb52c74..001e652bfd1904 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-03-15 +date: 2022-03-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.devdocs.json b/api_docs/vis_default_editor.devdocs.json index f073badd0ffd1f..31fe2478171c1b 100644 --- a/api_docs/vis_default_editor.devdocs.json +++ b/api_docs/vis_default_editor.devdocs.json @@ -430,6 +430,37 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "visDefaultEditor", + "id": "def-public.LegendSizeSettings", + "type": "Function", + "tags": [], + "label": "LegendSizeSettings", + "description": [], + "signature": [ + "({ legendSize, onLegendSizeChange, isVerticalLegend, }: LegendSizeSettingsProps) => JSX.Element" + ], + "path": "src/plugins/vis_default_editor/public/components/options/legend_size_settings.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "visDefaultEditor", + "id": "def-public.LegendSizeSettings.$1", + "type": "Object", + "tags": [], + "label": "{\n legendSize,\n onLegendSizeChange,\n isVerticalLegend,\n}", + "description": [], + "signature": [ + "LegendSizeSettingsProps" + ], + "path": "src/plugins/vis_default_editor/public/components/options/legend_size_settings.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "visDefaultEditor", "id": "def-public.LongLegendOptions", diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index 72157baf871898..92aca2d65f47d1 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-03-15 +date: 2022-03-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. --- @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 57 | 0 | 50 | 3 | +| 59 | 0 | 52 | 3 | ## Client diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index 31540c950b00fe..05737040dd35e0 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-03-15 +date: 2022-03-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 b8ce1d142b4a01..ae829993102867 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-03-15 +date: 2022-03-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 954746c6c09557..71f55f6c124034 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-03-15 +date: 2022-03-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 4bd021990cb71a..9b76ee3081a073 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-03-15 +date: 2022-03-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 0e38b472141cb8..2c1b45b1a95618 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-03-15 +date: 2022-03-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 1462af010e66a2..f0db6193a0678e 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-03-15 +date: 2022-03-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 0f3d2d7cc17298..8954d4256c6059 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-03-15 +date: 2022-03-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 45f074545e8f6a..d7a00a728cb198 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-03-15 +date: 2022-03-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 507a6a1d96a5a3..93013f5c62201a 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-03-15 +date: 2022-03-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 f7b0988824623f..a6f758e30e8a45 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -303,16 +303,16 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[] | Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]>) | undefined" ], @@ -1257,7 +1257,7 @@ "section": "def-common.Dimension", "text": "Dimension" }, - "[]) => { columns: { meta: { dimensionName: string | undefined; type: ", + "[], removeUnmappedColumns?: boolean) => { columns: { meta: { dimensionName: string | undefined; type: ", { "pluginId": "expressions", "scope": "common", @@ -1283,7 +1283,9 @@ }, "> | undefined; source?: string | undefined; sourceParams?: ", "SerializableRecord", - " | undefined; }; id: string; name: string; }[]; type: \"datatable\"; rows: ", + " | undefined; }; id: string; name: string; }[]; type: \"datatable\"; meta?: ", + "DatatableMeta", + " | undefined; rows: ", { "pluginId": "expressions", "scope": "common", @@ -1336,6 +1338,20 @@ "path": "src/plugins/visualizations/common/utils/prepare_log_table.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "visualizations", + "id": "def-public.prepareLogTable.$3", + "type": "boolean", + "tags": [], + "label": "removeUnmappedColumns", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/visualizations/common/utils/prepare_log_table.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [], @@ -2009,7 +2025,7 @@ "label": "sharingSavedObjectProps", "description": [], "signature": [ - "{ outcome?: \"conflict\" | \"aliasMatch\" | \"exactMatch\" | undefined; aliasTargetId?: string | undefined; errorJSON?: string | undefined; } | undefined" + "{ outcome?: \"exactMatch\" | \"aliasMatch\" | \"conflict\" | undefined; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; errorJSON?: string | undefined; } | undefined" ], "path": "src/plugins/visualizations/public/types.ts", "deprecated": false @@ -2688,8 +2704,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], @@ -3659,16 +3675,16 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[] | Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]>) | undefined" ], @@ -6091,7 +6107,7 @@ "section": "def-common.Dimension", "text": "Dimension" }, - "[]) => { columns: { meta: { dimensionName: string | undefined; type: ", + "[], removeUnmappedColumns?: boolean) => { columns: { meta: { dimensionName: string | undefined; type: ", { "pluginId": "expressions", "scope": "common", @@ -6117,7 +6133,9 @@ }, "> | undefined; source?: string | undefined; sourceParams?: ", "SerializableRecord", - " | undefined; }; id: string; name: string; }[]; type: \"datatable\"; rows: ", + " | undefined; }; id: string; name: string; }[]; type: \"datatable\"; meta?: ", + "DatatableMeta", + " | undefined; rows: ", { "pluginId": "expressions", "scope": "common", @@ -6170,6 +6188,20 @@ "path": "src/plugins/visualizations/common/utils/prepare_log_table.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "visualizations", + "id": "def-common.prepareLogTable.$3", + "type": "boolean", + "tags": [], + "label": "removeUnmappedColumns", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/visualizations/common/utils/prepare_log_table.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [], diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index 91c05270d676ae..2adf19201ea086 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-03-15 +date: 2022-03-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. --- @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 361 | 12 | 340 | 14 | +| 363 | 12 | 342 | 14 | ## Client diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index 34c22850160860..25656a3977fead 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -56,7 +56,7 @@ pageLoadAssetSize: telemetry: 51957 telemetryManagementSection: 38586 transform: 41007 - triggersActionsUi: 100000 + triggersActionsUi: 102400 upgradeAssistant: 81241 uptime: 40825 urlForwarding: 32579 diff --git a/packages/kbn-pm/dist/index.js b/packages/kbn-pm/dist/index.js index b086f398faea4f..5c1403494e9447 100644 --- a/packages/kbn-pm/dist/index.js +++ b/packages/kbn-pm/dist/index.js @@ -8921,11 +8921,10 @@ const BootstrapCommand = { ms: Date.now() - start }); } - }; // Force install is set in case a flag is passed into yarn kbn bootstrap or if the `.yarn-integrity` - // file is not found which will be indicated by the return of yarnIntegrityFileExists. + }; // Force install is set in case a flag is passed into yarn kbn bootstrap - const forceInstall = !!options && options['force-install'] === true || !(await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_9__["yarnIntegrityFileExists"])(Object(path__WEBPACK_IMPORTED_MODULE_0__["resolve"])(kibanaProjectPath, 'node_modules'))); // Install bazel machinery tools if needed + const forceInstall = !!options && options['force-install'] === true; // Install bazel machinery tools if needed await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_9__["installBazelTools"])(rootPath); // Setup remote cache settings in .bazelrc.cache if needed @@ -52669,8 +52668,6 @@ __webpack_require__.r(__webpack_exports__); /* harmony import */ var _yarn_integrity__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(527); /* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "removeYarnIntegrityFileIfExists", function() { return _yarn_integrity__WEBPACK_IMPORTED_MODULE_3__["removeYarnIntegrityFileIfExists"]; }); -/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "yarnIntegrityFileExists", function() { return _yarn_integrity__WEBPACK_IMPORTED_MODULE_3__["yarnIntegrityFileExists"]; }); - /* * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one * or more contributor license agreements. Licensed under the Elastic License @@ -52896,6 +52893,7 @@ async function runBazelCommandWithRunner(bazelCommandRunner, bazelArgs, offline try { await bazelProc; } catch { + _log__WEBPACK_IMPORTED_MODULE_5__["log"].error('HINT: If experiencing problems with node_modules try `yarn kbn bootstrap --force-install` or as last resort `yarn kbn reset && yarn kbn bootstrap`'); throw new _errors__WEBPACK_IMPORTED_MODULE_6__["CliError"](`The bazel command that was running failed to complete.`); } @@ -59103,7 +59101,6 @@ function observeReadable(readable) { "use strict"; __webpack_require__.r(__webpack_exports__); /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "removeYarnIntegrityFileIfExists", function() { return removeYarnIntegrityFileIfExists; }); -/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "yarnIntegrityFileExists", function() { return yarnIntegrityFileExists; }); /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(4); /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_0__); /* harmony import */ var _fs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(231); @@ -59127,19 +59124,6 @@ async function removeYarnIntegrityFileIfExists(nodeModulesPath) { } catch {// no-op } } -async function yarnIntegrityFileExists(nodeModulesPath) { - try { - const nodeModulesRealPath = await Object(_fs__WEBPACK_IMPORTED_MODULE_1__["tryRealpath"])(nodeModulesPath); - const yarnIntegrityFilePath = Object(path__WEBPACK_IMPORTED_MODULE_0__["join"])(nodeModulesRealPath, '.yarn-integrity'); // check if the file already exists - - if (await Object(_fs__WEBPACK_IMPORTED_MODULE_1__["isFile"])(yarnIntegrityFilePath)) { - return true; - } - } catch {// no-op - } - - return false; -} /***/ }), /* 528 */ diff --git a/packages/kbn-pm/src/commands/bootstrap.ts b/packages/kbn-pm/src/commands/bootstrap.ts index 7b5c8c2b6b37d7..51577df6c3b878 100644 --- a/packages/kbn-pm/src/commands/bootstrap.ts +++ b/packages/kbn-pm/src/commands/bootstrap.ts @@ -17,12 +17,7 @@ import { ICommand } from './'; import { readYarnLock } from '../utils/yarn_lock'; import { sortPackageJson } from '../utils/sort_package_json'; import { validateDependencies } from '../utils/validate_dependencies'; -import { - installBazelTools, - removeYarnIntegrityFileIfExists, - runBazel, - yarnIntegrityFileExists, -} from '../utils/bazel'; +import { installBazelTools, removeYarnIntegrityFileIfExists, runBazel } from '../utils/bazel'; import { setupRemoteCache } from '../utils/bazel/setup_remote_cache'; export const BootstrapCommand: ICommand = { @@ -54,11 +49,8 @@ export const BootstrapCommand: ICommand = { } }; - // Force install is set in case a flag is passed into yarn kbn bootstrap or if the `.yarn-integrity` - // file is not found which will be indicated by the return of yarnIntegrityFileExists. - const forceInstall = - (!!options && options['force-install'] === true) || - !(await yarnIntegrityFileExists(resolve(kibanaProjectPath, 'node_modules'))); + // Force install is set in case a flag is passed into yarn kbn bootstrap + const forceInstall = !!options && options['force-install'] === true; // Install bazel machinery tools if needed await installBazelTools(rootPath); diff --git a/packages/kbn-pm/src/utils/bazel/run.ts b/packages/kbn-pm/src/utils/bazel/run.ts index c030081e53daaf..18a6cacdf6d2a6 100644 --- a/packages/kbn-pm/src/utils/bazel/run.ts +++ b/packages/kbn-pm/src/utils/bazel/run.ts @@ -52,6 +52,9 @@ async function runBazelCommandWithRunner( try { await bazelProc; } catch { + log.error( + 'HINT: If experiencing problems with node_modules try `yarn kbn bootstrap --force-install` or as last resort `yarn kbn reset && yarn kbn bootstrap`' + ); throw new CliError(`The bazel command that was running failed to complete.`); } await bazelLogs$.toPromise(); diff --git a/packages/kbn-pm/src/utils/bazel/yarn_integrity.ts b/packages/kbn-pm/src/utils/bazel/yarn_integrity.ts index 76910786898aad..1ac9bfeba1e3b3 100644 --- a/packages/kbn-pm/src/utils/bazel/yarn_integrity.ts +++ b/packages/kbn-pm/src/utils/bazel/yarn_integrity.ts @@ -22,19 +22,3 @@ export async function removeYarnIntegrityFileIfExists(nodeModulesPath: string) { // no-op } } - -export async function yarnIntegrityFileExists(nodeModulesPath: string) { - try { - const nodeModulesRealPath = await tryRealpath(nodeModulesPath); - const yarnIntegrityFilePath = join(nodeModulesRealPath, '.yarn-integrity'); - - // check if the file already exists - if (await isFile(yarnIntegrityFilePath)) { - return true; - } - } catch { - // no-op - } - - return false; -} diff --git a/packages/kbn-securitysolution-rules/src/configuration_constants.ts b/packages/kbn-securitysolution-rules/src/configuration_constants.ts new file mode 100644 index 00000000000000..115c6996739db4 --- /dev/null +++ b/packages/kbn-securitysolution-rules/src/configuration_constants.ts @@ -0,0 +1,12 @@ +/* + * 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. + */ + +/** + * Max number of execution events to aggregate in memory for the Rule Execution Log + */ +export const MAX_EXECUTION_EVENTS_DISPLAYED = 1000 as const; diff --git a/packages/kbn-securitysolution-rules/src/index.ts b/packages/kbn-securitysolution-rules/src/index.ts index 1d59b9842c90d1..45d35ea80b39ce 100644 --- a/packages/kbn-securitysolution-rules/src/index.ts +++ b/packages/kbn-securitysolution-rules/src/index.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +export * from './configuration_constants'; export * from './rule_type_constants'; export * from './rule_type_mappings'; export * from './utils'; diff --git a/src/core/public/core_app/styles/_mixins.scss b/src/core/public/core_app/styles/_mixins.scss index d088a47144f33a..a801ffd7a2caee 100644 --- a/src/core/public/core_app/styles/_mixins.scss +++ b/src/core/public/core_app/styles/_mixins.scss @@ -91,7 +91,7 @@ } &::before { - position: absolute; + position: fixed; top: 0; left: 0; z-index: 1; diff --git a/src/plugins/controls/common/control_types/range_slider/range_slider_persistable_state.ts b/src/plugins/controls/common/control_types/range_slider/range_slider_persistable_state.ts new file mode 100644 index 00000000000000..c50fe3f6fb7100 --- /dev/null +++ b/src/plugins/controls/common/control_types/range_slider/range_slider_persistable_state.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 { + EmbeddableStateWithType, + EmbeddablePersistableStateService, +} from '../../../../embeddable/common'; +import { RangeSliderEmbeddableInput } from './types'; +import { SavedObjectReference } from '../../../../../core/types'; +import { DATA_VIEW_SAVED_OBJECT_TYPE } from '../../../../data_views/common'; + +type RangeSliderInputWithType = Partial & { type: string }; +const dataViewReferenceName = 'optionsListDataView'; + +export const createRangeSliderInject = (): EmbeddablePersistableStateService['inject'] => { + return (state: EmbeddableStateWithType, references: SavedObjectReference[]) => { + const workingState = { ...state } as EmbeddableStateWithType | RangeSliderInputWithType; + references.forEach((reference) => { + if (reference.name === dataViewReferenceName) { + (workingState as RangeSliderInputWithType).dataViewId = reference.id; + } + }); + return workingState as EmbeddableStateWithType; + }; +}; + +export const createRangeSliderExtract = (): EmbeddablePersistableStateService['extract'] => { + return (state: EmbeddableStateWithType) => { + const workingState = { ...state } as EmbeddableStateWithType | RangeSliderInputWithType; + const references: SavedObjectReference[] = []; + + if ('dataViewId' in workingState) { + references.push({ + name: dataViewReferenceName, + type: DATA_VIEW_SAVED_OBJECT_TYPE, + id: workingState.dataViewId!, + }); + delete workingState.dataViewId; + } + return { state: workingState as EmbeddableStateWithType, references }; + }; +}; diff --git a/src/plugins/controls/common/control_types/range_slider/types.ts b/src/plugins/controls/common/control_types/range_slider/types.ts new file mode 100644 index 00000000000000..e63ec0337a57e0 --- /dev/null +++ b/src/plugins/controls/common/control_types/range_slider/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. + */ + +import { ControlInput } from '../../types'; + +export const RANGE_SLIDER_CONTROL = 'rangeSliderControl'; + +export type RangeValue = [string, string]; + +export interface RangeSliderEmbeddableInput extends ControlInput { + fieldName: string; + dataViewId: string; + value: RangeValue; +} diff --git a/src/plugins/controls/common/index.ts b/src/plugins/controls/common/index.ts index e10258026e64d8..23779e225ce47e 100644 --- a/src/plugins/controls/common/index.ts +++ b/src/plugins/controls/common/index.ts @@ -6,10 +6,13 @@ * Side Public License, v 1. */ +export type { ControlWidth } from './types'; export type { ControlPanelState, ControlsPanels, ControlGroupInput } from './control_group/types'; export type { OptionsListEmbeddableInput } from './control_types/options_list/types'; -export type { ControlWidth } from './types'; +export type { RangeSliderEmbeddableInput } from './control_types/range_slider/types'; -export { OPTIONS_LIST_CONTROL } from './control_types/options_list/types'; export { CONTROL_GROUP_TYPE } from './control_group/types'; +export { OPTIONS_LIST_CONTROL } from './control_types/options_list/types'; +export { RANGE_SLIDER_CONTROL } from './control_types/range_slider/types'; + export { getDefaultControlGroupInput } from './control_group/control_group_constants'; diff --git a/src/plugins/controls/public/__stories__/controls.stories.tsx b/src/plugins/controls/public/__stories__/controls.stories.tsx index 436cee506916a3..12bf0cacbe1363 100644 --- a/src/plugins/controls/public/__stories__/controls.stories.tsx +++ b/src/plugins/controls/public/__stories__/controls.stories.tsx @@ -19,7 +19,9 @@ import { import { ControlGroupContainerFactory, OptionsListEmbeddableInput, + RangeSliderEmbeddableInput, OPTIONS_LIST_CONTROL, + RANGE_SLIDER_CONTROL, } from '../'; import { ViewMode } from '../../../embeddable/public'; @@ -169,6 +171,65 @@ export const ConfiguredControlGroupStory = () => ( fieldName: 'Carrier', } as OptionsListEmbeddableInput, }, + rangeSlider1: { + type: RANGE_SLIDER_CONTROL, + order: 4, + width: 'auto', + explicitInput: { + id: 'rangeSlider1', + title: 'Average ticket price', + dataViewId: 'demoDataFlights', + fieldName: 'AvgTicketPrice', + value: ['4', '12'], + step: 2, + } as RangeSliderEmbeddableInput, + }, + }} + /> +); + +export const RangeSliderControlGroupStory = () => ( + ); diff --git a/src/plugins/controls/public/__stories__/storybook_control_factories.ts b/src/plugins/controls/public/__stories__/storybook_control_factories.ts index 9809e90bd12fc5..12674a97d856da 100644 --- a/src/plugins/controls/public/__stories__/storybook_control_factories.ts +++ b/src/plugins/controls/public/__stories__/storybook_control_factories.ts @@ -7,6 +7,7 @@ */ import { OptionsListEmbeddableFactory } from '../control_types/options_list'; +import { RangeSliderEmbeddableFactory } from '../control_types/range_slider'; import { ControlsService } from '../services/controls'; import { ControlFactory } from '..'; @@ -17,4 +18,11 @@ export const populateStorybookControlFactories = (controlsServiceStub: ControlsS const optionsListControlFactory = optionsListFactoryStub as unknown as ControlFactory; optionsListControlFactory.getDefaultInput = () => ({}); controlsServiceStub.registerControlType(optionsListControlFactory); + + const rangeSliderFactoryStub = new RangeSliderEmbeddableFactory(); + + // cast to unknown because the stub cannot use the embeddable start contract to transform the EmbeddableFactoryDefinition into an EmbeddableFactory + const rangeSliderControlFactory = rangeSliderFactoryStub as unknown as ControlFactory; + rangeSliderControlFactory.getDefaultInput = () => ({}); + controlsServiceStub.registerControlType(rangeSliderControlFactory); }; diff --git a/src/plugins/controls/public/control_types/index.ts b/src/plugins/controls/public/control_types/index.ts index 141e9f9b4d55f6..2b53723f4bafd7 100644 --- a/src/plugins/controls/public/control_types/index.ts +++ b/src/plugins/controls/public/control_types/index.ts @@ -7,3 +7,4 @@ */ export * from './options_list'; +export * from './range_slider'; diff --git a/src/plugins/controls/public/control_types/options_list/options_list_strings.ts b/src/plugins/controls/public/control_types/options_list/options_list_strings.ts index 62fb54163c2bdf..f6dd7f3a2ddf19 100644 --- a/src/plugins/controls/public/control_types/options_list/options_list_strings.ts +++ b/src/plugins/controls/public/control_types/options_list/options_list_strings.ts @@ -28,10 +28,6 @@ export const OptionsListStrings = { }), }, editor: { - getIndexPatternTitle: () => - i18n.translate('controls.optionsList.editor.indexPatternTitle', { - defaultMessage: 'Index pattern', - }), getDataViewTitle: () => i18n.translate('controls.optionsList.editor.dataViewTitle', { defaultMessage: 'Data view', diff --git a/src/plugins/controls/public/control_types/range_slider/index.ts b/src/plugins/controls/public/control_types/range_slider/index.ts new file mode 100644 index 00000000000000..5fdd29672b86fa --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/index.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. + */ + +export { RANGE_SLIDER_CONTROL } from '../../../common/control_types/range_slider/types'; +export { RangeSliderEmbeddableFactory } from './range_slider_embeddable_factory'; + +export type { RangeSliderEmbeddable } from './range_slider_embeddable'; +export type { RangeSliderEmbeddableInput } from '../../../common/control_types/range_slider/types'; diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider.component.tsx b/src/plugins/controls/public/control_types/range_slider/range_slider.component.tsx new file mode 100644 index 00000000000000..822c88ca10df0e --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/range_slider.component.tsx @@ -0,0 +1,72 @@ +/* + * 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, useCallback, useState } from 'react'; +import { BehaviorSubject } from 'rxjs'; + +import { DataViewField } from '../../../../data_views/public'; +import { useReduxEmbeddableContext } from '../../../../presentation_util/public'; +import { useStateObservable } from '../../hooks/use_state_observable'; +import { RangeSliderPopover } from './range_slider_popover'; +import { rangeSliderReducers } from './range_slider_reducers'; +import { RangeSliderEmbeddableInput, RangeValue } from './types'; + +import './range_slider.scss'; + +interface Props { + componentStateSubject: BehaviorSubject; +} +// Availableoptions and loading state is controled by the embeddable, but is not considered embeddable input. +export interface RangeSliderComponentState { + field?: DataViewField; + fieldFormatter: (value: string) => string; + min: string; + max: string; + loading: boolean; +} + +export const RangeSliderComponent: FC = ({ componentStateSubject }) => { + // Redux embeddable Context to get state from Embeddable input + const { + useEmbeddableDispatch, + useEmbeddableSelector, + actions: { selectRange }, + } = useReduxEmbeddableContext(); + const dispatch = useEmbeddableDispatch(); + + // useStateObservable to get component state from Embeddable + const { loading, min, max, fieldFormatter } = useStateObservable( + componentStateSubject, + componentStateSubject.getValue() + ); + + const { value = ['', ''], id, title } = useEmbeddableSelector((state) => state); + + const [selectedValue, setSelectedValue] = useState(value || ['', '']); + + const onChangeComplete = useCallback( + (range: RangeValue) => { + dispatch(selectRange(range)); + setSelectedValue(range); + }, + [selectRange, setSelectedValue, dispatch] + ); + + return ( + + ); +}; diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider.scss b/src/plugins/controls/public/control_types/range_slider/range_slider.scss new file mode 100644 index 00000000000000..82d892cd0b9c51 --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/range_slider.scss @@ -0,0 +1,57 @@ +.rangeSlider__popoverOverride { + height: 100%; + max-width: 100%; + width: 100%; +} + +@include euiBreakpoint('m', 'l', 'xl') { + .rangeSlider__panelOverride { + min-width: $euiSizeXXL * 12; + } +} + +.rangeSlider__anchorOverride { + >div { + height: 100%; + } +} + +.rangeSliderAnchor__button { + display: flex; + align-items: center; + width: 100%; + height: 100%; + justify-content: space-between; + background-color: $euiFormBackgroundColor; + @include euiFormControlSideBorderRadius($euiFormControlBorderRadius, $side: 'right', $internal: true); + + .euiToolTipAnchor { + width: 100%; + } + + .rangeSliderAnchor__delimiter { + background-color: unset; + } + .rangeSliderAnchor__fieldNumber { + font-weight: $euiFontWeightBold; + box-shadow: none; + text-align: center; + background-color: unset; + + &::placeholder { + font-weight: $euiFontWeightRegular; + color: $euiColorMediumShade; + text-decoration: none; + } + } + + .rangeSliderAnchor__fieldNumber--invalid { + text-decoration: line-through; + font-weight: $euiFontWeightRegular; + color: $euiColorMediumShade; + } + + .rangeSliderAnchor__spinner { + padding-right: $euiSizeS; + } +} \ No newline at end of file diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider_editor.tsx b/src/plugins/controls/public/control_types/range_slider/range_slider_editor.tsx new file mode 100644 index 00000000000000..d2dbef62f2b0f4 --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/range_slider_editor.tsx @@ -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 useMount from 'react-use/lib/useMount'; +import React, { useEffect, useState } from 'react'; +import { EuiFormRow } from '@elastic/eui'; + +import { pluginServices } from '../../services'; +import { ControlEditorProps } from '../../types'; +import { RangeSliderEmbeddableInput } from './types'; +import { RangeSliderStrings } from './range_slider_strings'; +import { DataViewListItem, DataView } from '../../../../data_views/common'; +import { + LazyDataViewPicker, + LazyFieldPicker, + withSuspense, +} from '../../../../presentation_util/public'; + +interface RangeSliderEditorState { + dataViewListItems: DataViewListItem[]; + dataView?: DataView; + fieldName?: string; +} + +const FieldPicker = withSuspense(LazyFieldPicker, null); +const DataViewPicker = withSuspense(LazyDataViewPicker, null); + +export const RangeSliderEditor = ({ + onChange, + initialInput, + setValidState, + setDefaultTitle, +}: ControlEditorProps) => { + // Controls Services Context + const { dataViews } = pluginServices.getHooks(); + const { getIdsWithTitle, getDefaultId, get } = dataViews.useService(); + + const [state, setState] = useState({ + fieldName: initialInput?.fieldName, + dataViewListItems: [], + }); + + useMount(() => { + let mounted = true; + if (state.fieldName) setDefaultTitle(state.fieldName); + (async () => { + const dataViewListItems = await getIdsWithTitle(); + const initialId = initialInput?.dataViewId ?? (await getDefaultId()); + let dataView: DataView | undefined; + if (initialId) { + onChange({ dataViewId: initialId }); + dataView = await get(initialId); + } + if (!mounted) return; + setState((s) => ({ ...s, dataView, dataViewListItems })); + })(); + return () => { + mounted = false; + }; + }); + + useEffect( + () => setValidState(Boolean(state.fieldName) && Boolean(state.dataView)), + [state.fieldName, setValidState, state.dataView] + ); + + const { dataView, fieldName } = state; + return ( + <> + + { + onChange({ dataViewId }); + get(dataViewId).then((newDataView) => + setState((s) => ({ ...s, dataView: newDataView })) + ); + }} + trigger={{ + label: state.dataView?.title ?? RangeSliderStrings.editor.getNoDataViewTitle(), + }} + /> + + + field.aggregatable && field.type === 'number'} + selectedFieldName={fieldName} + dataView={dataView} + onSelectField={(field) => { + setDefaultTitle(field.displayName ?? field.name); + onChange({ fieldName: field.name }); + setState((s) => ({ ...s, fieldName: field.name })); + }} + /> + + + ); +}; diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider_embeddable.tsx b/src/plugins/controls/public/control_types/range_slider/range_slider_embeddable.tsx new file mode 100644 index 00000000000000..ef4bc41abeefc8 --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/range_slider_embeddable.tsx @@ -0,0 +1,330 @@ +/* + * 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 { isEmpty } from 'lodash'; +import { + compareFilters, + buildRangeFilter, + COMPARE_ALL_OPTIONS, + RangeFilterParams, +} from '@kbn/es-query'; +import React from 'react'; +import ReactDOM from 'react-dom'; +import { get, isEqual } from 'lodash'; +import deepEqual from 'fast-deep-equal'; +import { Subscription, BehaviorSubject } from 'rxjs'; +import { debounceTime, distinctUntilChanged, skip, map } from 'rxjs/operators'; + +import { + withSuspense, + LazyReduxEmbeddableWrapper, + ReduxEmbeddableWrapperPropsWithChildren, +} from '../../../../presentation_util/public'; +import { Embeddable, IContainer } from '../../../../embeddable/public'; +import { DataView, DataViewField } from '../../../../data_views/public'; + +import { ControlsDataViewsService } from '../../services/data_views'; +import { ControlsDataService } from '../../services/data'; +import { ControlInput, ControlOutput } from '../..'; +import { pluginServices } from '../../services'; + +import { RangeSliderComponent, RangeSliderComponentState } from './range_slider.component'; +import { rangeSliderReducers } from './range_slider_reducers'; +import { RangeSliderStrings } from './range_slider_strings'; +import { RangeSliderEmbeddableInput, RANGE_SLIDER_CONTROL } from './types'; + +const RangeSliderReduxWrapper = withSuspense< + ReduxEmbeddableWrapperPropsWithChildren +>(LazyReduxEmbeddableWrapper); + +const diffDataFetchProps = ( + current?: RangeSliderDataFetchProps, + last?: RangeSliderDataFetchProps +) => { + if (!current || !last) return false; + const { filters: currentFilters, ...currentWithoutFilters } = current; + const { filters: lastFilters, ...lastWithoutFilters } = last; + if (!deepEqual(currentWithoutFilters, lastWithoutFilters)) return false; + if (!compareFilters(lastFilters ?? [], currentFilters ?? [], COMPARE_ALL_OPTIONS)) return false; + return true; +}; + +interface RangeSliderDataFetchProps { + fieldName: string; + dataViewId: string; + query?: ControlInput['query']; + filters?: ControlInput['filters']; +} + +const fieldMissingError = (fieldName: string) => + new Error(`field ${fieldName} not found in index pattern`); + +export class RangeSliderEmbeddable extends Embeddable { + public readonly type = RANGE_SLIDER_CONTROL; + public deferEmbeddableLoad = true; + + private subscriptions: Subscription = new Subscription(); + private node?: HTMLElement; + + // Controls services + private dataService: ControlsDataService; + private dataViewsService: ControlsDataViewsService; + + // Internal data fetching state for this input control. + private dataView?: DataView; + private field?: DataViewField; + + // State to be passed down to component + private componentState: RangeSliderComponentState; + private componentStateSubject$ = new BehaviorSubject({ + min: '', + max: '', + loading: true, + fieldFormatter: (value: string) => value, + }); + + constructor(input: RangeSliderEmbeddableInput, output: ControlOutput, parent?: IContainer) { + super(input, output, parent); // get filters for initial output... + + // Destructure controls services + ({ data: this.dataService, dataViews: this.dataViewsService } = pluginServices.getServices()); + + this.componentState = { + min: '', + max: '', + loading: true, + fieldFormatter: (value: string) => value, + }; + this.updateComponentState(this.componentState); + + this.initialize(); + } + + private initialize = async () => { + const initialValue = this.getInput().value; + if (!initialValue) { + this.setInitializationFinished(); + } + + this.fetchMinMax().then(async () => { + if (initialValue) { + this.setInitializationFinished(); + } + this.setupSubscriptions(); + }); + }; + + private setupSubscriptions = () => { + const dataFetchPipe = this.getInput$().pipe( + map((newInput) => ({ + lastReloadRequestTime: newInput.lastReloadRequestTime, + dataViewId: newInput.dataViewId, + fieldName: newInput.fieldName, + timeRange: newInput.timeRange, + filters: newInput.filters, + query: newInput.query, + })), + distinctUntilChanged(diffDataFetchProps), + skip(1) + ); + + // fetch available min/max when input changes + this.subscriptions.add(dataFetchPipe.subscribe(this.fetchMinMax)); + + // build filters when value change + this.subscriptions.add( + this.getInput$() + .pipe( + debounceTime(400), + distinctUntilChanged((a, b) => isEqual(a.value, b.value)), + skip(1) // skip the first input update because initial filters will be built by initialize. + ) + .subscribe(this.buildFilter) + ); + }; + + private getCurrentDataViewAndField = async (): Promise<{ + dataView: DataView; + field: DataViewField; + }> => { + const { dataViewId, fieldName } = this.getInput(); + if (!this.dataView || this.dataView.id !== dataViewId) { + this.dataView = await this.dataViewsService.get(dataViewId); + if (this.dataView === undefined) { + this.onFatalError( + new Error(RangeSliderStrings.errors.getDataViewNotFoundError(dataViewId)) + ); + } + } + + if (!this.field || this.field.name !== fieldName) { + this.field = this.dataView.getFieldByName(fieldName); + if (this.field === undefined) { + this.onFatalError(new Error(RangeSliderStrings.errors.getDataViewNotFoundError(fieldName))); + } + + this.updateComponentState({ + field: this.field, + fieldFormatter: this.field + ? this.dataView.getFormatterForField(this.field).getConverterFor('text') + : (value: string) => value, + }); + } + + return { dataView: this.dataView, field: this.field! }; + }; + + private updateComponentState(changes: Partial) { + this.componentState = { + ...this.componentState, + ...changes, + }; + this.componentStateSubject$.next(this.componentState); + } + + private minMaxAgg = (field?: DataViewField) => { + const aggBody: any = {}; + if (field) { + if (field.scripted) { + aggBody.script = { + source: field.script, + lang: field.lang, + }; + } else { + aggBody.field = field.name; + } + } + + return { + maxAgg: { + max: aggBody, + }, + minAgg: { + min: aggBody, + }, + }; + }; + + private fetchMinMax = async () => { + this.updateComponentState({ loading: true }); + this.updateOutput({ loading: true }); + const { dataView, field } = await this.getCurrentDataViewAndField(); + const embeddableInput = this.getInput(); + const { ignoreParentSettings, fieldName, query, timeRange } = embeddableInput; + let { filters = [] } = embeddableInput; + + if (!field) { + this.updateComponentState({ loading: false }); + this.updateOutput({ loading: false }); + throw fieldMissingError(fieldName); + } + + if (ignoreParentSettings?.ignoreFilters) { + filters = []; + } + + if (!ignoreParentSettings?.ignoreTimerange && timeRange) { + const timeFilter = this.dataService.timefilter.createFilter(dataView, timeRange); + if (timeFilter) { + filters = filters.concat(timeFilter); + } + } + + const searchSource = await this.dataService.searchSource.create(); + searchSource.setField('size', 0); + searchSource.setField('index', dataView); + + const aggs = this.minMaxAgg(field); + searchSource.setField('aggs', aggs); + + searchSource.setField('filter', filters); + + if (!ignoreParentSettings?.ignoreQuery) { + searchSource.setField('query', query); + } + + const resp = await searchSource.fetch$().toPromise(); + + const min = get(resp, 'rawResponse.aggregations.minAgg.value', ''); + const max = get(resp, 'rawResponse.aggregations.maxAgg.value', ''); + + this.updateComponentState({ + min: `${min ?? ''}`, + max: `${max ?? ''}`, + }); + + // build filter with new min/max + await this.buildFilter(); + }; + + private buildFilter = async () => { + const { value: [selectedMin, selectedMax] = ['', ''], ignoreParentSettings } = this.getInput(); + + const hasData = !isEmpty(this.componentState.min) && !isEmpty(this.componentState.max); + const hasLowerSelection = !isEmpty(selectedMin); + const hasUpperSelection = !isEmpty(selectedMax); + const hasEitherSelection = hasLowerSelection || hasUpperSelection; + const hasBothSelections = hasLowerSelection && hasUpperSelection; + const hasInvalidSelection = + !ignoreParentSettings?.ignoreValidations && + hasBothSelections && + parseFloat(selectedMin) > parseFloat(selectedMax); + const isLowerSelectionOutOfRange = + hasLowerSelection && parseFloat(selectedMin) > parseFloat(this.componentState.max); + const isUpperSelectionOutOfRange = + hasUpperSelection && parseFloat(selectedMax) < parseFloat(this.componentState.min); + const isSelectionOutOfRange = + (!ignoreParentSettings?.ignoreValidations && hasData && isLowerSelectionOutOfRange) || + isUpperSelectionOutOfRange; + const { dataView, field } = await this.getCurrentDataViewAndField(); + + if (!hasData || !hasEitherSelection || hasInvalidSelection || isSelectionOutOfRange) { + this.updateComponentState({ loading: false }); + this.updateOutput({ filters: [], dataViews: [dataView], loading: false }); + return; + } + + const params = {} as RangeFilterParams; + + if (selectedMin) { + params.gte = selectedMin; + } + if (selectedMax) { + params.lte = selectedMax; + } + + const rangeFilter = buildRangeFilter(field, params, dataView); + + rangeFilter.meta.key = field?.name; + + this.updateComponentState({ loading: false }); + this.updateOutput({ filters: [rangeFilter], dataViews: [dataView], loading: false }); + }; + + reload = () => { + this.fetchMinMax(); + }; + + public destroy = () => { + super.destroy(); + this.subscriptions.unsubscribe(); + }; + + public render = (node: HTMLElement) => { + if (this.node) { + ReactDOM.unmountComponentAtNode(this.node); + } + this.node = node; + ReactDOM.render( + + + , + node + ); + }; +} diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider_embeddable_factory.tsx b/src/plugins/controls/public/control_types/range_slider/range_slider_embeddable_factory.tsx new file mode 100644 index 00000000000000..fbdaff4f5b3492 --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/range_slider_embeddable_factory.tsx @@ -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. + */ + +import deepEqual from 'fast-deep-equal'; + +import { RangeSliderEditor } from './range_slider_editor'; +import { ControlEmbeddable, IEditableControlFactory } from '../../types'; +import { RangeSliderEmbeddableInput, RANGE_SLIDER_CONTROL } from './types'; +import { EmbeddableFactoryDefinition, IContainer } from '../../../../embeddable/public'; +import { + createRangeSliderExtract, + createRangeSliderInject, +} from '../../../common/control_types/range_slider/range_slider_persistable_state'; +import { RangeSliderStrings } from './range_slider_strings'; + +export class RangeSliderEmbeddableFactory + implements EmbeddableFactoryDefinition, IEditableControlFactory +{ + public type = RANGE_SLIDER_CONTROL; + public canCreateNew = () => false; + + constructor() {} + + public async create(initialInput: RangeSliderEmbeddableInput, parent?: IContainer) { + const { RangeSliderEmbeddable } = await import('./range_slider_embeddable'); + return Promise.resolve(new RangeSliderEmbeddable(initialInput, {}, parent)); + } + + public presaveTransformFunction = ( + newInput: Partial, + embeddable?: ControlEmbeddable + ) => { + if ( + embeddable && + (!deepEqual(newInput.fieldName, embeddable.getInput().fieldName) || + !deepEqual(newInput.dataViewId, embeddable.getInput().dataViewId)) + ) { + // if the field name or data view id has changed in this editing session, selected values are invalid, so reset them. + newInput.value = ['', '']; + } + return newInput; + }; + + public controlEditorComponent = RangeSliderEditor; + + public isEditable = () => Promise.resolve(false); + + public getDisplayName = () => RangeSliderStrings.getDisplayName(); + public getIconType = () => 'controlsHorizontal'; + public getDescription = () => RangeSliderStrings.getDescription(); + + public inject = createRangeSliderInject(); + public extract = createRangeSliderExtract(); +} diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider_popover.tsx b/src/plugins/controls/public/control_types/range_slider/range_slider_popover.tsx new file mode 100644 index 00000000000000..a4ed84ec01a2e1 --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/range_slider_popover.tsx @@ -0,0 +1,242 @@ +/* + * 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, useState, useRef } from 'react'; +import { + EuiFieldNumber, + EuiPopoverTitle, + EuiText, + EuiInputPopover, + EuiButtonIcon, + EuiToolTip, + EuiLoadingSpinner, + EuiFlexGroup, + EuiFlexItem, + EuiDualRange, +} from '@elastic/eui'; + +import { RangeSliderStrings } from './range_slider_strings'; +import { RangeValue } from './types'; + +export interface Props { + id: string; + isLoading?: boolean; + min: string; + max: string; + title?: string; + value: RangeValue; + onChange: (value: RangeValue) => void; + fieldFormatter: (value: string) => string; +} + +export const RangeSliderPopover: FC = ({ + id, + isLoading, + min, + max, + title, + value, + onChange, + fieldFormatter, +}) => { + const [isPopoverOpen, setIsPopoverOpen] = useState(false); + const rangeRef = useRef(null); + let errorMessage = ''; + let helpText = ''; + + const hasAvailableRange = min !== '' && max !== ''; + const hasLowerBoundSelection = value[0] !== ''; + const hasUpperBoundSelection = value[1] !== ''; + + const lowerBoundValue = parseFloat(value[0]); + const upperBoundValue = parseFloat(value[1]); + const minValue = parseFloat(min); + const maxValue = parseFloat(max); + + if (!hasAvailableRange) { + helpText = 'There is no data to display. Adjust the time range and filters.'; + } + + // EuiDualRange can only handle integers as min/max + const roundedMin = hasAvailableRange ? Math.floor(minValue) : minValue; + const roundedMax = hasAvailableRange ? Math.ceil(maxValue) : maxValue; + + const isLowerSelectionInvalid = hasLowerBoundSelection && lowerBoundValue > roundedMax; + const isUpperSelectionInvalid = hasUpperBoundSelection && upperBoundValue < roundedMin; + const isSelectionInvalid = + hasAvailableRange && (isLowerSelectionInvalid || isUpperSelectionInvalid); + + if (isSelectionInvalid) { + helpText = RangeSliderStrings.popover.getNoDataHelpText(); + } + + if (lowerBoundValue > upperBoundValue) { + errorMessage = RangeSliderStrings.errors.getUpperLessThanLowerErrorMessage(); + } + + const rangeSliderMin = Math.min( + roundedMin, + isNaN(lowerBoundValue) ? Infinity : lowerBoundValue, + isNaN(upperBoundValue) ? Infinity : upperBoundValue + ); + const rangeSliderMax = Math.max( + roundedMax, + isNaN(lowerBoundValue) ? -Infinity : lowerBoundValue, + isNaN(upperBoundValue) ? -Infinity : upperBoundValue + ); + + const displayedValue = [ + hasLowerBoundSelection ? String(lowerBoundValue) : hasAvailableRange ? String(roundedMin) : '', + hasUpperBoundSelection ? String(upperBoundValue) : hasAvailableRange ? String(roundedMax) : '', + ] as RangeValue; + + const ticks = []; + const levels = []; + + if (hasAvailableRange) { + ticks.push({ value: rangeSliderMin, label: fieldFormatter(String(rangeSliderMin)) }); + ticks.push({ value: rangeSliderMax, label: fieldFormatter(String(rangeSliderMax)) }); + levels.push({ min: roundedMin, max: roundedMax, color: 'success' }); + } + + const button = ( + + ); + + return ( + setIsPopoverOpen(false)} + anchorPosition="downCenter" + initialFocus={false} + repositionOnScroll + disableFocusTrap + onPanelResize={() => { + if (rangeRef?.current) { + rangeRef.current.onResize(); + } + }} + > + {title} + + + { + const updatedLowerBound = + typeof newLowerBound === 'number' ? String(newLowerBound) : value[0]; + const updatedUpperBound = + typeof newUpperBound === 'number' ? String(newUpperBound) : value[1]; + + onChange([updatedLowerBound, updatedUpperBound]); + }} + value={displayedValue} + ticks={hasAvailableRange ? ticks : undefined} + levels={hasAvailableRange ? levels : undefined} + showTicks={hasAvailableRange} + disabled={!hasAvailableRange} + fullWidth + ref={rangeRef} + data-test-subj="rangeSlider__slider" + /> + + {errorMessage || helpText} + + + {hasAvailableRange ? ( + + + onChange(['', ''])} + aria-label={RangeSliderStrings.popover.getClearRangeButtonTitle()} + data-test-subj="rangeSlider__clearRangeButton" + /> + + + ) : null} + + + ); +}; diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider_reducers.ts b/src/plugins/controls/public/control_types/range_slider/range_slider_reducers.ts new file mode 100644 index 00000000000000..ce7e5ced101a61 --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/range_slider_reducers.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. + */ + +import { PayloadAction } from '@reduxjs/toolkit'; +import { WritableDraft } from 'immer/dist/types/types-external'; + +import { RangeSliderEmbeddableInput, RangeValue } from './types'; + +export const rangeSliderReducers = { + selectRange: ( + state: WritableDraft, + action: PayloadAction + ) => { + state.value = action.payload; + }, +}; diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider_strings.ts b/src/plugins/controls/public/control_types/range_slider/range_slider_strings.ts new file mode 100644 index 00000000000000..a901f79ba20f57 --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/range_slider_strings.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. + */ + +import { i18n } from '@kbn/i18n'; + +export const RangeSliderStrings = { + getDisplayName: () => + i18n.translate('controls.rangeSlider.displayName', { + defaultMessage: 'Range slider', + }), + getDescription: () => + i18n.translate('controls.rangeSlider.description', { + defaultMessage: 'Add a control for selecting a range of field values.', + }), + editor: { + getDataViewTitle: () => + i18n.translate('controls.rangeSlider.editor.dataViewTitle', { + defaultMessage: 'Data view', + }), + getNoDataViewTitle: () => + i18n.translate('controls.rangeSlider.editor.noDataViewTitle', { + defaultMessage: 'Select data view', + }), + getFieldTitle: () => + i18n.translate('controls.rangeSlider.editor.fieldTitle', { + defaultMessage: 'Field', + }), + }, + popover: { + getAllOptionsButtonTitle: () => + i18n.translate('controls.rangeSlider.popover.allOptionsTitle', { + defaultMessage: 'Show all options', + }), + getClearRangeButtonTitle: () => + i18n.translate('controls.rangeSlider.popover.clearRangeTitle', { + defaultMessage: 'Clear range', + }), + getNoDataHelpText: () => + i18n.translate('controls.rangeSlider.popover.noDataHelpText', { + defaultMessage: 'Selected range is outside of available data. No filter was applied.', + }), + }, + errors: { + getDataViewNotFoundError: (dataViewId: string) => + i18n.translate('controls.optionsList.errors.dataViewNotFound', { + defaultMessage: 'Could not locate data view: {dataViewId}', + values: { dataViewId }, + }), + getUpperLessThanLowerErrorMessage: () => + i18n.translate('controls.rangeSlider.popover.upperLessThanLowerErrorMessage', { + defaultMessage: 'The upper bound must be greater than or equal to the lower bound.', + }), + }, +}; diff --git a/src/plugins/controls/public/control_types/range_slider/types.ts b/src/plugins/controls/public/control_types/range_slider/types.ts new file mode 100644 index 00000000000000..e9ebe61bf62674 --- /dev/null +++ b/src/plugins/controls/public/control_types/range_slider/types.ts @@ -0,0 +1,10 @@ +/* + * 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 '../../../common/control_types/options_list/types'; +export * from '../../../common/control_types/range_slider/types'; diff --git a/src/plugins/controls/public/index.ts b/src/plugins/controls/public/index.ts index 7caf9d19e49b2b..db4586b3150758 100644 --- a/src/plugins/controls/public/index.ts +++ b/src/plugins/controls/public/index.ts @@ -24,7 +24,7 @@ export type { ControlInput, } from '../common/types'; -export { OPTIONS_LIST_CONTROL, CONTROL_GROUP_TYPE } from '../common'; +export { CONTROL_GROUP_TYPE, OPTIONS_LIST_CONTROL, RANGE_SLIDER_CONTROL } from '../common'; export { ControlGroupContainer, @@ -37,6 +37,9 @@ export { OptionsListEmbeddableFactory, OptionsListEmbeddable, type OptionsListEmbeddableInput, + RangeSliderEmbeddableFactory, + RangeSliderEmbeddable, + type RangeSliderEmbeddableInput, } from './control_types'; export { LazyControlsCallout, type CalloutProps } from './controls_callout'; diff --git a/src/plugins/controls/public/plugin.ts b/src/plugins/controls/public/plugin.ts index 0c81f4c8261750..96cb7eeef3a274 100644 --- a/src/plugins/controls/public/plugin.ts +++ b/src/plugins/controls/public/plugin.ts @@ -20,7 +20,16 @@ import { OptionsListEmbeddableFactory, OptionsListEmbeddableInput, } from './control_types/options_list'; -import { ControlGroupContainerFactory, CONTROL_GROUP_TYPE, OPTIONS_LIST_CONTROL } from '.'; +import { + RangeSliderEmbeddableFactory, + RangeSliderEmbeddableInput, +} from './control_types/range_slider'; +import { + ControlGroupContainerFactory, + CONTROL_GROUP_TYPE, + OPTIONS_LIST_CONTROL, + RANGE_SLIDER_CONTROL, +} from '.'; import { controlsService } from './services/kibana/controls'; import { EmbeddableFactory } from '../../embeddable/public'; @@ -56,6 +65,7 @@ export class ControlsPlugin _setupPlugins: ControlsPluginSetupDeps ): ControlsPluginSetup { const { registerControlType } = controlsService; + const { embeddable } = _setupPlugins; // register control group embeddable factory _coreSetup.getStartServices().then(([, deps]) => { @@ -75,8 +85,19 @@ export class ControlsPlugin optionsListFactory ); registerControlType(optionsListFactory); + + // Register range slider + const rangeSliderFactoryDef = new RangeSliderEmbeddableFactory(); + const rangeSliderFactory = embeddable.registerEmbeddableFactory( + RANGE_SLIDER_CONTROL, + rangeSliderFactoryDef + )(); + this.transferEditorFunctions( + rangeSliderFactoryDef, + rangeSliderFactory + ); + registerControlType(rangeSliderFactory); }); - const { embeddable } = _setupPlugins; return { registerControlType, @@ -87,6 +108,7 @@ export class ControlsPlugin this.startControlsKibanaServices(coreStart, startPlugins); const { getControlFactory, getControlTypes } = controlsService; + return { getControlFactory, getControlTypes, diff --git a/src/plugins/controls/public/services/data.ts b/src/plugins/controls/public/services/data.ts index f25b3f6a958011..f11e4519955359 100644 --- a/src/plugins/controls/public/services/data.ts +++ b/src/plugins/controls/public/services/data.ts @@ -11,4 +11,6 @@ import { DataPublicPluginStart } from '../../../data/public'; export interface ControlsDataService { autocomplete: DataPublicPluginStart['autocomplete']; query: DataPublicPluginStart['query']; + searchSource: DataPublicPluginStart['search']['searchSource']; + timefilter: DataPublicPluginStart['query']['timefilter']['timefilter']; } diff --git a/src/plugins/controls/public/services/kibana/data.ts b/src/plugins/controls/public/services/kibana/data.ts index e411766fe0f34a..0830233109e2a6 100644 --- a/src/plugins/controls/public/services/kibana/data.ts +++ b/src/plugins/controls/public/services/kibana/data.ts @@ -17,10 +17,12 @@ export type DataServiceFactory = KibanaPluginServiceFactory< export const dataServiceFactory: DataServiceFactory = ({ startPlugins }) => { const { - data: { query, autocomplete }, + data: { autocomplete, query, search }, } = startPlugins; return { autocomplete, query, + searchSource: search.searchSource, + timefilter: query.timefilter.timefilter, }; }; diff --git a/src/plugins/controls/public/services/storybook/data.ts b/src/plugins/controls/public/services/storybook/data.ts index c26d7c0835295f..bfdcf05767b01a 100644 --- a/src/plugins/controls/public/services/storybook/data.ts +++ b/src/plugins/controls/public/services/storybook/data.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import { of } from 'rxjs'; import { PluginServiceFactory } from '../../../../presentation_util/public'; import { DataPublicPluginStart } from '../../../../data/public'; import { DataViewField } from '../../../../data_views/common'; @@ -23,4 +24,18 @@ export const dataServiceFactory: DataServiceFactory = () => ({ getValueSuggestions: valueSuggestionMethod, } as unknown as DataPublicPluginStart['autocomplete'], query: {} as unknown as DataPublicPluginStart['query'], + searchSource: { + create: () => ({ + setField: () => {}, + fetch$: () => + of({ + resp: { + rawResponse: { aggregations: { minAgg: { value: 0 }, maxAgg: { value: 1000 } } }, + }, + }), + }), + } as unknown as DataPublicPluginStart['search']['searchSource'], + timefilter: { + createFilter: () => {}, + } as unknown as DataPublicPluginStart['query']['timefilter']['timefilter'], }); diff --git a/src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.test.ts b/src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.test.ts index d5b071dda9f389..9462b8c5d171fc 100644 --- a/src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.test.ts +++ b/src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.test.ts @@ -116,7 +116,7 @@ describe('Kuery field suggestions', () => { expect(keywordIndex).toBeLessThan(analyzedIndex); }); - test('should have descriptions', async () => { + test('should not have descriptions', async () => { const prefix = ''; const suffix = ''; const suggestions = await getSuggestions( @@ -125,7 +125,7 @@ describe('Kuery field suggestions', () => { ); expect(suggestions.length).toBeGreaterThan(0); suggestions.forEach((suggestion) => { - expect(suggestion).toHaveProperty('description'); + expect(suggestion).not.toHaveProperty('description'); }); }); diff --git a/src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.tsx b/src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.tsx index dc34cd8dee247b..a0008101b5aeca 100644 --- a/src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.tsx +++ b/src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.tsx @@ -6,9 +6,7 @@ * Side Public License, v 1. */ -import React from 'react'; import { flatten } from 'lodash'; -import { FormattedMessage } from '@kbn/i18n-react'; import { escapeKuery } from './lib/escape_kuery'; import { sortPrefixFirst } from './sort_prefix_first'; import { @@ -19,18 +17,6 @@ import { } from '../../../../../../../src/plugins/data/public'; import { KqlQuerySuggestionProvider } from './types'; -const getDescription = (field: IFieldType) => { - return ( -

- {field.name} }} - /> -

- ); -}; - const keywordComparator = (first: IFieldType, second: IFieldType) => { const extensions = ['raw', 'keyword']; if (extensions.map((ext) => `${first.name}.${ext}`).includes(second.name)) { @@ -72,7 +58,6 @@ export const setupGetFieldSuggestions: KqlQuerySuggestionProvider 0 ? text.length - 2 @@ -81,7 +66,6 @@ export const setupGetFieldSuggestions: KqlQuerySuggestionProvider
This is not a helpful suggestion
@@ -63,6 +64,7 @@ exports[`SuggestionComponent Should make the element active if the selected prop
This is not a helpful suggestion
diff --git a/src/plugins/data/public/ui/typeahead/_suggestion.scss b/src/plugins/data/public/ui/typeahead/_suggestion.scss index 345c7493dc2933..9e0c163f9c94c7 100644 --- a/src/plugins/data/public/ui/typeahead/_suggestion.scss +++ b/src/plugins/data/public/ui/typeahead/_suggestion.scss @@ -4,6 +4,7 @@ $kbnTypeaheadTypes: ( value: $euiColorSuccess, operator: $euiColorPrimary, conjunction: $euiColorVis3, + recentSearch: $euiColorMediumShade, ); .kbnTypeahead.kbnTypeahead--small { @@ -88,11 +89,11 @@ $kbnTypeaheadTypes: ( } .kbnSuggestionItem { - display: flex; - flex-grow: 1; + display: inline-flex; align-items: center; font-size: $euiFontSizeXS; white-space: nowrap; + width: 100%; @each $name, $color in $kbnTypeaheadTypes { &.kbnSuggestionItem--#{$name} { @@ -102,29 +103,17 @@ $kbnTypeaheadTypes: ( } } } - - &.kbnSuggestionItem--recentSearch { - .kbnSuggestionItem__type { - background-color: $euiColorLightShade; - color: $euiColorMediumShade; - } - - .kbnSuggestionItem__text { - width: auto; - } - } } .kbnSuggestionItem__text, .kbnSuggestionItem__type, .kbnSuggestionItem__description { - flex-grow: 1; - flex-basis: 0%; - display: flex; - flex-direction: column; + padding-right: $euiSize; } .kbnSuggestionItem__type { + display: flex; + flex-direction: column; flex-grow: 0; flex-shrink: 0; flex-basis: auto; @@ -138,25 +127,28 @@ $kbnTypeaheadTypes: ( } .kbnSuggestionItem__text { - flex-grow: 0; /* 2 */ - flex-basis: auto; /* 2 */ font-family: $euiCodeFontFamily; - width: 250px; overflow: hidden; text-overflow: ellipsis; - padding: $euiSizeXS $euiSizeS; + padding-left: $euiSizeS; color: $euiTextColor; + min-width: 250px; } .kbnSuggestionItem__description { color: $euiColorDarkShade; overflow: hidden; text-overflow: ellipsis; - margin-left: $euiSizeXL; + flex-shrink: 1; + + // In case the description contains a paragraph in which the truncation needs to be at this level + > p { + overflow: hidden; + text-overflow: ellipsis; + } &:empty { - flex-grow: 0; - margin-left: 0; + width: 0; } } @@ -167,8 +159,3 @@ $kbnTypeaheadTypes: ( padding: 0 $euiSizeXS; display: inline-block; } - -.kbnSuggestionItem--value .kbnSuggestionItem__text { - flex-basis: 50%; - flex-grow: 1; -} diff --git a/src/plugins/data/public/ui/typeahead/suggestion_component.tsx b/src/plugins/data/public/ui/typeahead/suggestion_component.tsx index 8f555f710612b0..938fdb5c9fb2bb 100644 --- a/src/plugins/data/public/ui/typeahead/suggestion_component.tsx +++ b/src/plugins/data/public/ui/typeahead/suggestion_component.tsx @@ -75,7 +75,12 @@ export const SuggestionComponent = React.memo(function SuggestionComponent(props props.suggestion.type }-${props.suggestion.text.replace(/\s/g, '-')}`} > -
+
@@ -83,7 +88,12 @@ export const SuggestionComponent = React.memo(function SuggestionComponent(props {props.suggestion.text}
{props.shouldDisplayDescription && ( -
{props.suggestion.description}
+
+ {props.suggestion.description} +
)}
diff --git a/src/plugins/data/public/ui/typeahead/suggestions_component.tsx b/src/plugins/data/public/ui/typeahead/suggestions_component.tsx index 7a0a4378c4ddce..a5ee6f31ada316 100644 --- a/src/plugins/data/public/ui/typeahead/suggestions_component.tsx +++ b/src/plugins/data/public/ui/typeahead/suggestions_component.tsx @@ -88,14 +88,14 @@ export default class SuggestionsComponent extends PureComponent - {(containerWidth: number) => ( + {(rect: DOMRect) => (
- {renderSuggestions(containerWidth)} + {renderSuggestions(rect.width)}
)} @@ -158,9 +158,9 @@ const StyledSuggestionsListDiv = styled.div` const ResizableSuggestionsListDiv: React.FC<{ inputContainer: HTMLElement; suggestionsSize?: SuggestionsListSize; + children: (rect: DOMRect) => ReactNode; }> = React.memo((props) => { const inputContainer = props.inputContainer; - const children = props.children as (rect: DOMRect) => ReactNode; const [{ documentHeight }, { pageYOffset }, containerRect] = useDimensions(inputContainer); @@ -191,7 +191,7 @@ const ResizableSuggestionsListDiv: React.FC<{ ['kbnTypeahead__popover--top']: !isSuggestionsListFittable, })} > - {children(containerRect)} + {props.children(containerRect)} diff --git a/src/plugins/presentation_util/public/__stories__/fixtures/flights.ts b/src/plugins/presentation_util/public/__stories__/fixtures/flights.ts index 0ec82b1e1994be..d999db22b4057d 100644 --- a/src/plugins/presentation_util/public/__stories__/fixtures/flights.ts +++ b/src/plugins/presentation_util/public/__stories__/fixtures/flights.ts @@ -43,12 +43,22 @@ export const flightFieldNames: FlightField[] = [ 'timestamp', ]; +const numberFields = [ + 'AvgTicketPrice', + 'dayOfWeek', + 'DistanceKilometers', + 'DistanceMiles', + 'FlightDelayMin', + 'FlightTimeHour', + 'FlightTimeMin', +]; + export const flightFieldByName: { [key: string]: DataViewField } = {}; flightFieldNames.forEach( (flightFieldName) => (flightFieldByName[flightFieldName] = { name: flightFieldName, - type: 'string', + type: numberFields.includes(flightFieldName) ? 'number' : 'string', aggregatable: true, } as unknown as DataViewField) ); diff --git a/src/plugins/vis_types/vega/public/components/vega_vis.scss b/src/plugins/vis_types/vega/public/components/vega_vis.scss index f0062869e00469..ce66dc1d7f9285 100644 --- a/src/plugins/vis_types/vega/public/components/vega_vis.scss +++ b/src/plugins/vis_types/vega/public/components/vega_vis.scss @@ -24,6 +24,10 @@ width: 100%; height: 100%; + canvas { + display: block; + } + // BUG #23514: Make sure Vega doesn't display the controls in two places .vega-bindings { // sass-lint:disable no-important diff --git a/test/functional/apps/dashboard_elements/controls/index.ts b/test/functional/apps/dashboard_elements/controls/index.ts index a29834c848094b..f5ec41d593995d 100644 --- a/test/functional/apps/dashboard_elements/controls/index.ts +++ b/test/functional/apps/dashboard_elements/controls/index.ts @@ -49,6 +49,7 @@ export default function ({ loadTestFile, getService, getPageObjects }: FtrProvid loadTestFile(require.resolve('./controls_callout')); loadTestFile(require.resolve('./control_group_settings')); loadTestFile(require.resolve('./options_list')); + loadTestFile(require.resolve('./range_slider')); loadTestFile(require.resolve('./control_group_chaining')); }); } diff --git a/test/functional/apps/dashboard_elements/controls/options_list.ts b/test/functional/apps/dashboard_elements/controls/options_list.ts index 6c52581d2878fb..ce04b2b01c091c 100644 --- a/test/functional/apps/dashboard_elements/controls/options_list.ts +++ b/test/functional/apps/dashboard_elements/controls/options_list.ts @@ -100,8 +100,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const firstId = (await dashboardControls.getAllControlIds())[0]; await dashboardControls.editExistingControl(firstId); - await dashboardControls.optionsListEditorSetDataView('animals-*'); - await dashboardControls.optionsListEditorSetfield('animal.keyword'); + await dashboardControls.controlsEditorSetDataView('animals-*'); + await dashboardControls.controlsEditorSetfield('animal.keyword'); await dashboardControls.controlEditorSave(); // when creating a new filter, the ability to select a data view should be removed, because the dashboard now only has one data view diff --git a/test/functional/apps/dashboard_elements/controls/range_slider.ts b/test/functional/apps/dashboard_elements/controls/range_slider.ts new file mode 100644 index 00000000000000..b2132e1919bd6a --- /dev/null +++ b/test/functional/apps/dashboard_elements/controls/range_slider.ts @@ -0,0 +1,204 @@ +/* + * 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 expect from '@kbn/expect'; + +import { FtrProviderContext } from '../../../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const retry = getService('retry'); + const esArchiver = getService('esArchiver'); + const security = getService('security'); + const filterBar = getService('filterBar'); + const testSubjects = getService('testSubjects'); + const kibanaServer = getService('kibanaServer'); + const { dashboardControls, timePicker, common, dashboard } = getPageObjects([ + 'dashboardControls', + 'timePicker', + 'dashboard', + 'common', + 'header', + ]); + + describe('Range Slider Control', async () => { + before(async () => { + await security.testUser.setRoles([ + 'kibana_admin', + 'kibana_sample_admin', + 'test_logstash_reader', + ]); + await esArchiver.load('test/functional/fixtures/es_archiver/kibana_sample_data_flights'); + await kibanaServer.importExport.load( + 'test/functional/fixtures/kbn_archiver/dashboard/current/kibana' + ); + await kibanaServer.importExport.load( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + await kibanaServer.uiSettings.replace({ + defaultIndex: '0bf35f60-3dc9-11e8-8660-4d65aa086b3c', + }); + await common.navigateToApp('dashboard'); + await dashboardControls.enableControlsLab(); + await common.navigateToApp('dashboard'); + await dashboard.preserveCrossAppState(); + await dashboard.gotoDashboardLandingPage(); + await dashboard.clickNewDashboard(); + await timePicker.setAbsoluteRange( + 'Oct 22, 2018 @ 00:00:00.000', + 'Dec 3, 2018 @ 00:00:00.000' + ); + }); + + after(async () => { + await dashboardControls.clearAllControls(); + await kibanaServer.importExport.unload( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + await esArchiver.unload('test/functional/fixtures/es_archiver/kibana_sample_data_flights'); + await kibanaServer.uiSettings.unset('defaultIndex'); + await security.testUser.restoreDefaults(); + }); + + describe('create and edit', async () => { + it('can create a new range slider control from a blank state', async () => { + await dashboardControls.createRangeSliderControl({ fieldName: 'bytes', width: 'small' }); + expect(await dashboardControls.getControlsCount()).to.be(1); + }); + + it('can add a second range list control with a non-default data view', async () => { + await dashboardControls.createRangeSliderControl({ + dataViewTitle: 'kibana_sample_data_flights', + fieldName: 'AvgTicketPrice', + width: 'medium', + }); + expect(await dashboardControls.getControlsCount()).to.be(2); + const secondId = (await dashboardControls.getAllControlIds())[1]; + expect( + await dashboardControls.rangeSliderGetLowerBoundAttribute(secondId, 'placeholder') + ).to.be('100'); + expect( + await dashboardControls.rangeSliderGetUpperBoundAttribute(secondId, 'placeholder') + ).to.be('1200'); + // data views should be properly propagated from the control group to the dashboard + expect(await filterBar.getIndexPatterns()).to.be('logstash-*,kibana_sample_data_flights'); + }); + + it('renames an existing control', async () => { + const secondId = (await dashboardControls.getAllControlIds())[1]; + const newTitle = 'Average ticket price'; + await dashboardControls.editExistingControl(secondId); + await dashboardControls.controlEditorSetTitle(newTitle); + await dashboardControls.controlEditorSave(); + expect(await dashboardControls.doesControlTitleExist(newTitle)).to.be(true); + }); + + it('can edit range slider control', async () => { + const firstId = (await dashboardControls.getAllControlIds())[0]; + await dashboardControls.editExistingControl(firstId); + await dashboardControls.controlsEditorSetDataView('kibana_sample_data_flights'); + await dashboardControls.controlsEditorSetfield('dayOfWeek'); + await dashboardControls.controlEditorSave(); + await dashboardControls.rangeSliderWaitForLoading(); + expect( + await dashboardControls.rangeSliderGetLowerBoundAttribute(firstId, 'placeholder') + ).to.be('0'); + expect( + await dashboardControls.rangeSliderGetUpperBoundAttribute(firstId, 'placeholder') + ).to.be('6'); + // when creating a new filter, the ability to select a data view should be removed, because the dashboard now only has one data view + await retry.try(async () => { + await testSubjects.click('addFilter'); + const indexPatternSelectExists = await testSubjects.exists('filterIndexPatternsSelect'); + await filterBar.ensureFieldEditorModalIsClosed(); + expect(indexPatternSelectExists).to.be(false); + }); + }); + + it('can enter lower bound selection from the number field', async () => { + const firstId = (await dashboardControls.getAllControlIds())[0]; + await dashboardControls.rangeSliderSetLowerBound(firstId, '1'); + const lowerBoundSelection = await dashboardControls.rangeSliderGetLowerBoundAttribute( + firstId, + 'value' + ); + expect(lowerBoundSelection).to.be('1'); + }); + + it('can enter upper bound selection into the number field', async () => { + const firstId = (await dashboardControls.getAllControlIds())[0]; + await dashboardControls.rangeSliderSetUpperBound(firstId, '2'); + const upperBoundSelection = await dashboardControls.rangeSliderGetUpperBoundAttribute( + firstId, + 'value' + ); + expect(upperBoundSelection).to.be('2'); + }); + + it('applies filter from the first control on the second control', async () => { + await dashboardControls.rangeSliderWaitForLoading(); + const secondId = (await dashboardControls.getAllControlIds())[1]; + const availableMin = await dashboardControls.rangeSliderGetLowerBoundAttribute( + secondId, + 'placeholder' + ); + expect(availableMin).to.be('100'); + const availabeMax = await dashboardControls.rangeSliderGetUpperBoundAttribute( + secondId, + 'placeholder' + ); + expect(availabeMax).to.be('1000'); + }); + + it('can clear out selections by clicking the reset button', async () => { + const firstId = (await dashboardControls.getAllControlIds())[0]; + await dashboardControls.rangeSliderClearSelection(firstId); + const lowerBoundSelection = await dashboardControls.rangeSliderGetLowerBoundAttribute( + firstId, + 'value' + ); + expect(lowerBoundSelection.length).to.be(0); + const upperBoundSelection = await dashboardControls.rangeSliderGetUpperBoundAttribute( + firstId, + 'value' + ); + expect(upperBoundSelection.length).to.be(0); + }); + + it('deletes an existing control', async () => { + const firstId = (await dashboardControls.getAllControlIds())[0]; + await dashboardControls.removeExistingControl(firstId); + expect(await dashboardControls.getControlsCount()).to.be(1); + }); + }); + + describe('validation', async () => { + it('displays error message when upper bound selection is less than lower bound selection', async () => { + const firstId = (await dashboardControls.getAllControlIds())[0]; + await dashboardControls.rangeSliderSetLowerBound(firstId, '500'); + await dashboardControls.rangeSliderSetUpperBound(firstId, '400'); + }); + + it('disables inputs when no data available', async () => { + await dashboardControls.createRangeSliderControl({ fieldName: 'bytes', width: 'small' }); + const secondId = (await dashboardControls.getAllControlIds())[1]; + expect( + await dashboardControls.rangeSliderGetLowerBoundAttribute(secondId, 'disabled') + ).to.be('true'); + expect( + await dashboardControls.rangeSliderGetUpperBoundAttribute(secondId, 'disabled') + ).to.be('true'); + await dashboardControls.rangeSliderOpenPopover(secondId); + await dashboardControls.rangeSliderPopoverAssertOpen(); + expect( + await dashboardControls.rangeSliderGetDualRangeAttribute(secondId, 'disabled') + ).to.be('true'); + expect((await testSubjects.getVisibleText('rangeSlider__helpText')).length).to.be.above(0); + }); + }); + }); +} diff --git a/test/functional/apps/dashboard_elements/index.ts b/test/functional/apps/dashboard_elements/index.ts index 059576389f32e4..6bd3e4e04a9c95 100644 --- a/test/functional/apps/dashboard_elements/index.ts +++ b/test/functional/apps/dashboard_elements/index.ts @@ -23,6 +23,12 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) { await esArchiver.loadIfNeeded('test/functional/fixtures/es_archiver/long_window_logstash'); }); + after(async () => { + await esArchiver.unload('test/functional/fixtures/es_archiver/empty_kibana'); + await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); + await esArchiver.unload('test/functional/fixtures/es_archiver/long_window_logstash'); + }); + describe('dashboard elements ciGroup10', function () { this.tags('ciGroup10'); diff --git a/test/functional/config.js b/test/functional/config.js index bfd2da7518fb7f..9221bef808e011 100644 --- a/test/functional/config.js +++ b/test/functional/config.js @@ -34,7 +34,7 @@ export default async function ({ readConfigFile }) { esTestCluster: { ...commonConfig.get('esTestCluster'), - serverArgs: ['xpack.security.enabled=false'], + serverArgs: [`xpack.security.enabled=${process.env.ES_SECURITY_ENABLED ? 'true' : 'false'}`], }, kbnTestServer: { diff --git a/test/functional/page_objects/dashboard_page_controls.ts b/test/functional/page_objects/dashboard_page_controls.ts index f0dd7ed9ddd3d2..0f52bf1255693c 100644 --- a/test/functional/page_objects/dashboard_page_controls.ts +++ b/test/functional/page_objects/dashboard_page_controls.ts @@ -8,7 +8,11 @@ import expect from '@kbn/expect'; import { WebElementWrapper } from 'test/functional/services/lib/web_element_wrapper'; -import { OPTIONS_LIST_CONTROL, ControlWidth } from '../../../src/plugins/controls/common'; +import { + OPTIONS_LIST_CONTROL, + ControlWidth, + RANGE_SLIDER_CONTROL, +} from '../../../src/plugins/controls/common'; import { ControlGroupChainingSystem } from '../../../src/plugins/controls/common/control_group/types'; import { FtrService } from '../ftr_provider_context'; @@ -238,6 +242,14 @@ export class DashboardPageControls extends FtrService { }); } + public async clickExistingControl(controlId: string) { + const elementToClick = await this.getControlElementById(controlId); + await this.retry.try(async () => { + await elementToClick.click(); + await this.testSubjects.existOrFail(`control-action-${controlId}-edit`); + }); + } + public async editExistingControl(controlId: string) { this.log.debug(`Opening control editor for control: ${controlId}`); await this.hoverOverExistingControl(controlId); @@ -344,6 +356,26 @@ export class DashboardPageControls extends FtrService { } } + public async controlsEditorSetDataView(dataViewTitle: string) { + this.log.debug(`Setting control data view to ${dataViewTitle}`); + await this.testSubjects.click('open-data-view-picker'); + await this.retry.try(async () => { + await this.testSubjects.existOrFail('data-view-picker-title'); + }); + await this.testSubjects.click(`data-view-picker-${dataViewTitle}`); + } + + public async controlsEditorSetfield(fieldName: string, shouldSearch: boolean = false) { + this.log.debug(`Setting control field to ${fieldName}`); + if (shouldSearch) { + await this.testSubjects.setValue('field-search-input', fieldName); + } + await this.retry.try(async () => { + await this.testSubjects.existOrFail(`field-picker-select-${fieldName}`); + }); + await this.testSubjects.click(`field-picker-select-${fieldName}`); + } + // Options List editor functions public async createOptionsListControl({ dataViewTitle, @@ -359,8 +391,8 @@ export class DashboardPageControls extends FtrService { this.log.debug(`Creating options list control ${title ?? fieldName}`); await this.openCreateControlFlyout(OPTIONS_LIST_CONTROL); - if (dataViewTitle) await this.optionsListEditorSetDataView(dataViewTitle); - if (fieldName) await this.optionsListEditorSetfield(fieldName); + if (dataViewTitle) await this.controlsEditorSetDataView(dataViewTitle); + if (fieldName) await this.controlsEditorSetfield(fieldName); if (title) await this.controlEditorSetTitle(title); if (width) await this.controlEditorSetWidth(width); @@ -378,23 +410,93 @@ export class DashboardPageControls extends FtrService { return dataViewName; } - public async optionsListEditorSetDataView(dataViewTitle: string) { - this.log.debug(`Setting options list data view to ${dataViewTitle}`); - await this.testSubjects.click('open-data-view-picker'); + // Range slider functions + public async rangeSliderGetLowerBoundAttribute(controlId: string, attribute: string) { + this.log.debug(`Getting range slider lower bound ${attribute} for ${controlId}`); + return await this.testSubjects.getAttribute( + `range-slider-control-${controlId} > rangeSlider__lowerBoundFieldNumber`, + attribute + ); + } + public async rangeSliderGetUpperBoundAttribute(controlId: string, attribute: string) { + this.log.debug(`Getting range slider upper bound ${attribute} for ${controlId}`); + return await this.testSubjects.getAttribute( + `range-slider-control-${controlId} > rangeSlider__upperBoundFieldNumber`, + attribute + ); + } + public async rangeSliderGetDualRangeAttribute(controlId: string, attribute: string) { + this.log.debug(`Getting range slider dual range ${attribute} for ${controlId}`); + return await this.testSubjects.getAttribute(`rangeSlider__slider`, attribute); + } + public async rangeSliderSetLowerBound(controlId: string, value: string) { + this.log.debug(`Setting range slider lower bound to ${value}`); + await this.testSubjects.setValue( + `range-slider-control-${controlId} > rangeSlider__lowerBoundFieldNumber`, + value + ); + } + public async rangeSliderSetUpperBound(controlId: string, value: string) { + this.log.debug(`Setting range slider lower bound to ${value}`); + await this.testSubjects.setValue( + `range-slider-control-${controlId} > rangeSlider__upperBoundFieldNumber`, + value + ); + } + + public async rangeSliderOpenPopover(controlId: string) { + this.log.debug(`Opening popover for Range Slider: ${controlId}`); + await this.testSubjects.click(`range-slider-control-${controlId}`); await this.retry.try(async () => { - await this.testSubjects.existOrFail('data-view-picker-title'); + await this.testSubjects.existOrFail(`rangeSlider-control-actions`); }); - await this.testSubjects.click(`data-view-picker-${dataViewTitle}`); } - public async optionsListEditorSetfield(fieldName: string, shouldSearch: boolean = false) { - this.log.debug(`Setting options list field to ${fieldName}`); - if (shouldSearch) { - await this.testSubjects.setValue('field-search-input', fieldName); - } + public async rangeSliderEnsurePopoverIsClosed(controlId: string) { + this.log.debug(`Opening popover for Range Slider: ${controlId}`); + await this.testSubjects.click(`range-slider-control-${controlId}`); + await this.testSubjects.waitForDeleted(`rangeSlider-control-actions`); + } + + public async rangeSliderPopoverAssertOpen() { await this.retry.try(async () => { - await this.testSubjects.existOrFail(`field-picker-select-${fieldName}`); + if (!(await this.testSubjects.exists(`rangeSlider-control-actions`))) { + throw new Error('options list popover must be open before calling selectOption'); + } }); - await this.testSubjects.click(`field-picker-select-${fieldName}`); + } + + public async rangeSliderWaitForLoading() { + await this.testSubjects.waitForDeleted('range-slider-loading-spinner'); + } + + public async rangeSliderClearSelection(controlId: string) { + this.log.debug(`Clearing range slider selection from control: ${controlId}`); + await this.rangeSliderOpenPopover(controlId); + await this.rangeSliderPopoverAssertOpen(); + await this.testSubjects.click('rangeSlider__clearRangeButton'); + } + + // Range slider editor functions + public async createRangeSliderControl({ + dataViewTitle, + fieldName, + width, + title, + }: { + title?: string; + fieldName: string; + width?: ControlWidth; + dataViewTitle?: string; + }) { + this.log.debug(`Creating range slider control ${title ?? fieldName}`); + await this.openCreateControlFlyout(RANGE_SLIDER_CONTROL); + + if (dataViewTitle) await this.controlsEditorSetDataView(dataViewTitle); + if (fieldName) await this.controlsEditorSetfield(fieldName); + if (title) await this.controlEditorSetTitle(title); + if (width) await this.controlEditorSetWidth(width); + + await this.controlEditorSave(); } } diff --git a/test/functional/services/query_bar.ts b/test/functional/services/query_bar.ts index 55a27f0423eed6..ec5fc039101a5c 100644 --- a/test/functional/services/query_bar.ts +++ b/test/functional/services/query_bar.ts @@ -96,4 +96,16 @@ export class QueryBarService extends FtrService { } }); } + + private async getSuggestionsDescription() { + const suggestions = await this.testSubjects.findAll('autoCompleteSuggestionDescription'); + return Promise.all(suggestions.map((suggestion) => suggestion.getVisibleText())); + } + + public async expectSuggestionsDescription({ count }: { count: number }) { + await this.retry.try(async () => { + const suggestions = await this.getSuggestionsDescription(); + expect(suggestions.length).to.be(count); + }); + } } diff --git a/x-pack/plugins/alerting/common/alert.ts b/x-pack/plugins/alerting/common/alert.ts index 1628abff7efc17..9e48acd523d223 100644 --- a/x-pack/plugins/alerting/common/alert.ts +++ b/x-pack/plugins/alerting/common/alert.ts @@ -49,6 +49,7 @@ export enum AlertExecutionStatusWarningReasons { export interface AlertExecutionStatus { status: AlertExecutionStatuses; numberOfTriggeredActions?: number; + numberOfScheduledActions?: number; metrics?: RuleExecutionMetrics; lastExecutionDate: Date; lastDuration?: number; diff --git a/x-pack/plugins/alerting/common/execution_log_types.ts b/x-pack/plugins/alerting/common/execution_log_types.ts new file mode 100644 index 00000000000000..0307985265160d --- /dev/null +++ b/x-pack/plugins/alerting/common/execution_log_types.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const executionLogSortableColumns = [ + 'timestamp', + 'execution_duration', + 'total_search_duration', + 'es_search_duration', + 'schedule_delay', + 'num_triggered_actions', +] as const; + +export type ExecutionLogSortFields = typeof executionLogSortableColumns[number]; + +export interface IExecutionLog { + id: string; + timestamp: string; + duration_ms: number; + status: string; + message: string; + num_active_alerts: number; + num_new_alerts: number; + num_recovered_alerts: number; + num_triggered_actions: number; + num_succeeded_actions: number; + num_errored_actions: number; + total_search_duration_ms: number; + es_search_duration_ms: number; + schedule_delay_ms: number; + timed_out: boolean; +} + +export interface IExecutionLogResult { + total: number; + data: IExecutionLog[]; +} diff --git a/x-pack/plugins/alerting/common/index.ts b/x-pack/plugins/alerting/common/index.ts index 8a6fec74fb6190..732d9061e58daf 100644 --- a/x-pack/plugins/alerting/common/index.ts +++ b/x-pack/plugins/alerting/common/index.ts @@ -20,6 +20,7 @@ export * from './builtin_action_groups'; export * from './disabled_action_groups'; export * from './alert_notify_when_type'; export * from './parse_duration'; +export * from './execution_log_types'; export interface AlertingFrameworkHealth { isSufficientlySecure: boolean; diff --git a/x-pack/plugins/alerting/common/rule_task_instance.ts b/x-pack/plugins/alerting/common/rule_task_instance.ts index aa45618b33f247..54483babdfdd3f 100644 --- a/x-pack/plugins/alerting/common/rule_task_instance.ts +++ b/x-pack/plugins/alerting/common/rule_task_instance.ts @@ -24,6 +24,7 @@ const ruleExecutionMetricsSchema = t.partial({ const alertExecutionStore = t.partial({ numberOfTriggeredActions: t.number, + numberOfScheduledActions: t.number, triggeredActionsStatus: t.string, }); diff --git a/x-pack/plugins/alerting/server/lib/format_execution_log_errors.test.ts b/x-pack/plugins/alerting/server/lib/format_execution_log_errors.test.ts new file mode 100644 index 00000000000000..70cfe4294020fd --- /dev/null +++ b/x-pack/plugins/alerting/server/lib/format_execution_log_errors.test.ts @@ -0,0 +1,230 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { formatExecutionErrorsResult } from './format_execution_log_errors'; +import { QueryEventsBySavedObjectResult } from '../../../event_log/server'; + +describe('formatExecutionErrorsResult', () => { + test('should return empty results if data is undefined', () => { + expect(formatExecutionErrorsResult({} as QueryEventsBySavedObjectResult)).toEqual({ + totalErrors: 0, + errors: [], + }); + }); + test('should format results correctly', () => { + const results = getEsResults({ + data: [ + { + timestamp: '2022-03-23T17:37:07.106Z', + provider: 'actions', + action: 'execute', + outcome: 'failure', + kind: 'action', + executionUuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: test-connector', + errorMessage: + 'an error occurred while running the action executor: something funky with the server log', + }, + { + timestamp: '2022-03-23T17:37:07.102Z', + provider: 'actions', + action: 'execute', + outcome: 'failure', + kind: 'action', + executionUuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: test-connector', + errorMessage: + 'an error occurred while running the action executor: something funky with the server log', + }, + { + timestamp: '2022-03-23T17:23:05.249Z', + provider: 'alerting', + action: 'execute', + outcome: 'failure', + kind: 'alert', + executionUuid: 'c1c04f04-312e-4e23-8e36-e01eb4332ed6', + message: `rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule'`, + errorMessage: 'I am erroring in rule execution!!', + }, + ], + }); + expect(formatExecutionErrorsResult(results)).toEqual({ + totalErrors: 6, + errors: [ + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.106Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: test-connector - an error occurred while running the action executor: something funky with the server log', + }, + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.102Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: test-connector - an error occurred while running the action executor: something funky with the server log', + }, + { + id: 'c1c04f04-312e-4e23-8e36-e01eb4332ed6', + timestamp: '2022-03-23T17:23:05.249Z', + type: 'alerting', + message: `rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule' - I am erroring in rule execution!!`, + }, + ], + }); + }); + test('should format results correctly with timeout', () => { + const results = getEsResults({ + data: [ + { + timestamp: '2022-03-24T15:34:13.199Z', + provider: 'alerting', + action: 'execute-timeout', + kind: 'alert', + executionUuid: 'a427f8cb-0e03-4270-90b2-ec325f4f082c', + message: `rule: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule' execution cancelled due to timeout - exceeded rule type timeout of 3s`, + }, + { + timestamp: '2022-03-23T17:37:07.106Z', + provider: 'actions', + action: 'execute', + outcome: 'failure', + kind: 'action', + executionUuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: test-connector', + errorMessage: + 'an error occurred while running the action executor: something funky with the server log', + }, + { + timestamp: '2022-03-23T17:37:07.102Z', + provider: 'actions', + action: 'execute', + outcome: 'failure', + kind: 'action', + executionUuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: test-connector', + errorMessage: + 'an error occurred while running the action executor: something funky with the server log', + }, + { + timestamp: '2022-03-23T17:23:05.249Z', + provider: 'alerting', + action: 'execute', + outcome: 'failure', + kind: 'alert', + executionUuid: 'c1c04f04-312e-4e23-8e36-e01eb4332ed6', + message: `rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule'`, + errorMessage: 'I am erroring in rule execution!!', + }, + ], + }); + expect(formatExecutionErrorsResult(results)).toEqual({ + totalErrors: 6, + errors: [ + { + id: 'a427f8cb-0e03-4270-90b2-ec325f4f082c', + timestamp: '2022-03-24T15:34:13.199Z', + type: 'alerting', + message: + "rule: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule' execution cancelled due to timeout - exceeded rule type timeout of 3s", + }, + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.106Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: test-connector - an error occurred while running the action executor: something funky with the server log', + }, + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.102Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: test-connector - an error occurred while running the action executor: something funky with the server log', + }, + { + id: 'c1c04f04-312e-4e23-8e36-e01eb4332ed6', + timestamp: '2022-03-23T17:23:05.249Z', + type: 'alerting', + message: `rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule' - I am erroring in rule execution!!`, + }, + ], + }); + }); +}); + +interface GetEsResult { + timestamp: string; + provider: string; + action: string; + outcome?: string; + kind: string; + executionUuid: string; + message: string; + errorMessage?: string; +} +interface GetEsResultsOpts { + page?: number; + perPage?: number; + total?: number; + data: GetEsResult[]; +} + +function getEsResults({ + page = 1, + perPage = 500, + total = 6, + data, +}: GetEsResultsOpts): QueryEventsBySavedObjectResult { + return { + page, + per_page: perPage, + total, + data: data.map((d: GetEsResult) => ({ + '@timestamp': d.timestamp, + event: { + provider: d.provider, + action: d.action, + kind: d.kind, + ...(d.outcome ? { outcome: d.outcome } : {}), + }, + kibana: { + alert: { + rule: { + execution: { + uuid: d.executionUuid, + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'a348a740-9e2c-11ec-bd64-774ed95c43ef', + type_id: 'example.always-firing', + }, + ], + task: { + scheduled: '2022-03-23T17:37:04.674Z', + schedule_delay: 2431000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + message: d.message, + ...(d.errorMessage ? { error: { message: d.errorMessage } } : {}), + ecs: { + version: '1.8.0', + }, + })), + }; +} diff --git a/x-pack/plugins/alerting/server/lib/format_execution_log_errors.ts b/x-pack/plugins/alerting/server/lib/format_execution_log_errors.ts new file mode 100644 index 00000000000000..a169640c4fc831 --- /dev/null +++ b/x-pack/plugins/alerting/server/lib/format_execution_log_errors.ts @@ -0,0 +1,58 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { get } from 'lodash'; +import { QueryEventsBySavedObjectResult, IValidatedEvent } from '../../../event_log/server'; + +const EXECUTION_UUID_FIELD = 'kibana.alert.rule.execution.uuid'; +const TIMESTAMP_FIELD = '@timestamp'; +const PROVIDER_FIELD = 'event.provider'; +const MESSAGE_FIELD = 'message'; +const ERROR_MESSAGE_FIELD = 'error.message'; + +export interface IExecutionErrors { + id: string; + timestamp: string; + type: string; + message: string; +} + +export interface IExecutionErrorsResult { + totalErrors: number; + errors: IExecutionErrors[]; +} + +export const EMPTY_EXECUTION_ERRORS_RESULT = { + totalErrors: 0, + errors: [], +}; + +function formatEvent(event: IValidatedEvent): IExecutionErrors { + const message = get(event, MESSAGE_FIELD, ''); + const errorMessage = get(event, ERROR_MESSAGE_FIELD, null); + return { + id: get(event, EXECUTION_UUID_FIELD, ''), + timestamp: get(event, TIMESTAMP_FIELD, ''), + type: get(event, PROVIDER_FIELD, ''), + message: errorMessage ? `${message} - ${errorMessage}` : message, + }; +} + +export function formatExecutionErrorsResult( + results: QueryEventsBySavedObjectResult +): IExecutionErrorsResult { + const { total, data } = results; + + if (!data) { + return EMPTY_EXECUTION_ERRORS_RESULT; + } + + return { + totalErrors: total, + errors: data.map((event: IValidatedEvent) => formatEvent(event)), + }; +} diff --git a/x-pack/plugins/alerting/server/lib/get_execution_log_aggregation.test.ts b/x-pack/plugins/alerting/server/lib/get_execution_log_aggregation.test.ts index 92999a80f6b998..6d6871b7ac111f 100644 --- a/x-pack/plugins/alerting/server/lib/get_execution_log_aggregation.test.ts +++ b/x-pack/plugins/alerting/server/lib/get_execution_log_aggregation.test.ts @@ -197,7 +197,10 @@ describe('getExecutionLogAggregation', () => { }, executionDuration: { max: { field: 'event.duration' } }, outcomeAndMessage: { - top_hits: { size: 1, _source: { includes: ['event.outcome', 'message'] } }, + top_hits: { + size: 1, + _source: { includes: ['event.outcome', 'message', 'error.message'] }, + }, }, }, }, @@ -446,6 +449,231 @@ describe('formatExecutionLogResult', () => { }); }); + test('should format results correctly with rule execution errors', () => { + const results = { + aggregations: { + executionUuid: { + meta: {}, + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [ + { + key: '6705da7d-2635-499d-a6a8-1aee1ae1eac9', + doc_count: 27, + timeoutMessage: { + meta: {}, + doc_count: 0, + }, + alertCounts: { + meta: {}, + buckets: { + activeAlerts: { + doc_count: 5, + }, + newAlerts: { + doc_count: 5, + }, + recoveredAlerts: { + doc_count: 0, + }, + }, + }, + ruleExecution: { + meta: {}, + doc_count: 1, + numTriggeredActions: { + value: 5.0, + }, + outcomeAndMessage: { + hits: { + total: { + value: 1, + relation: 'eq', + }, + max_score: 1.0, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'S4wIZX8B8TGQpG7XQZns', + _score: 1.0, + _source: { + event: { + outcome: 'failure', + }, + message: + "rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule'", + error: { + message: 'I am erroring in rule execution!!', + }, + }, + }, + ], + }, + }, + scheduleDelay: { + value: 3.074e9, + }, + totalSearchDuration: { + value: 0.0, + }, + esSearchDuration: { + value: 0.0, + }, + executionDuration: { + value: 1.056e9, + }, + executeStartTime: { + value: 1.646667512617e12, + value_as_string: '2022-03-07T15:38:32.617Z', + }, + }, + actionExecution: { + meta: {}, + doc_count: 5, + actionOutcomes: { + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [ + { + key: 'success', + doc_count: 5, + }, + ], + }, + }, + }, + { + key: '41b2755e-765a-4044-9745-b03875d5e79a', + doc_count: 32, + timeoutMessage: { + meta: {}, + doc_count: 0, + }, + alertCounts: { + meta: {}, + buckets: { + activeAlerts: { + doc_count: 5, + }, + newAlerts: { + doc_count: 5, + }, + recoveredAlerts: { + doc_count: 5, + }, + }, + }, + ruleExecution: { + meta: {}, + doc_count: 1, + numTriggeredActions: { + value: 5.0, + }, + outcomeAndMessage: { + hits: { + total: { + value: 1, + relation: 'eq', + }, + max_score: 1.0, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'a4wIZX8B8TGQpG7Xwpnz', + _score: 1.0, + _source: { + event: { + outcome: 'success', + }, + message: + "rule executed: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule'", + }, + }, + ], + }, + }, + scheduleDelay: { + value: 3.126e9, + }, + totalSearchDuration: { + value: 0.0, + }, + esSearchDuration: { + value: 0.0, + }, + executionDuration: { + value: 1.165e9, + }, + executeStartTime: { + value: 1.646667545604e12, + value_as_string: '2022-03-07T15:39:05.604Z', + }, + }, + actionExecution: { + meta: {}, + doc_count: 5, + actionOutcomes: { + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [ + { + key: 'success', + doc_count: 5, + }, + ], + }, + }, + }, + ], + }, + executionUuidCardinality: { + value: 374, + }, + }, + }; + expect(formatExecutionLogResult(results)).toEqual({ + total: 374, + data: [ + { + id: '6705da7d-2635-499d-a6a8-1aee1ae1eac9', + timestamp: '2022-03-07T15:38:32.617Z', + duration_ms: 1056, + status: 'failure', + message: + "rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule' - I am erroring in rule execution!!", + num_active_alerts: 5, + num_new_alerts: 5, + num_recovered_alerts: 0, + num_triggered_actions: 5, + num_succeeded_actions: 5, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 0, + timed_out: false, + schedule_delay_ms: 3074, + }, + { + id: '41b2755e-765a-4044-9745-b03875d5e79a', + timestamp: '2022-03-07T15:39:05.604Z', + duration_ms: 1165, + status: 'success', + message: + "rule executed: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule'", + num_active_alerts: 5, + num_new_alerts: 5, + num_recovered_alerts: 5, + num_triggered_actions: 5, + num_succeeded_actions: 5, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 0, + timed_out: false, + schedule_delay_ms: 3126, + }, + ], + }); + }); + test('should format results correctly when execution timeouts occur', () => { const results = { aggregations: { diff --git a/x-pack/plugins/alerting/server/lib/get_execution_log_aggregation.ts b/x-pack/plugins/alerting/server/lib/get_execution_log_aggregation.ts index 445cec6ad8412d..d090e7f649228a 100644 --- a/x-pack/plugins/alerting/server/lib/get_execution_log_aggregation.ts +++ b/x-pack/plugins/alerting/server/lib/get_execution_log_aggregation.ts @@ -10,6 +10,7 @@ import Boom from '@hapi/boom'; import { flatMap, get } from 'lodash'; import { parseDuration } from '.'; import { AggregateEventsBySavedObjectResult } from '../../../event_log/server'; +import { IExecutionLog, IExecutionLogResult } from '../../common'; const DEFAULT_MAX_BUCKETS_LIMIT = 1000; // do not retrieve more than this number of executions @@ -19,6 +20,7 @@ const ACTION_FIELD = 'event.action'; const OUTCOME_FIELD = 'event.outcome'; const DURATION_FIELD = 'event.duration'; const MESSAGE_FIELD = 'message'; +const ERROR_MESSAGE_FIELD = 'error.message'; const SCHEDULE_DELAY_FIELD = 'kibana.task.schedule_delay'; const ES_SEARCH_DURATION_FIELD = 'kibana.alert.rule.execution.metrics.es_search_duration_ms'; const TOTAL_SEARCH_DURATION_FIELD = 'kibana.alert.rule.execution.metrics.total_search_duration_ms'; @@ -28,28 +30,10 @@ const EXECUTION_UUID_FIELD = 'kibana.alert.rule.execution.uuid'; const Millis2Nanos = 1000 * 1000; -export interface IExecutionLog { - id: string; - timestamp: string; - duration_ms: number; - status: string; - message: string; - num_active_alerts: number; - num_new_alerts: number; - num_recovered_alerts: number; - num_triggered_actions: number; - num_succeeded_actions: number; - num_errored_actions: number; - total_search_duration_ms: number; - es_search_duration_ms: number; - schedule_delay_ms: number; - timed_out: boolean; -} - -export interface IExecutionLogResult { - total: number; - data: IExecutionLog[]; -} +export const EMPTY_EXECUTION_LOG_RESULT = { + total: 0, + data: [], +}; interface IAlertCounts extends estypes.AggregationsMultiBucketAggregateBase { buckets: { @@ -207,7 +191,7 @@ export function getExecutionLogAggregation({ page, perPage, sort }: IExecutionLo top_hits: { size: 1, _source: { - includes: [OUTCOME_FIELD, MESSAGE_FIELD], + includes: [OUTCOME_FIELD, MESSAGE_FIELD, ERROR_MESSAGE_FIELD], }, }, }, @@ -256,12 +240,18 @@ function formatExecutionLogAggBucket(bucket: IExecutionUuidAggBucket): IExecutio const actionExecutionError = actionExecutionOutcomes.find((subBucket) => subBucket?.key === 'failure')?.doc_count ?? 0; + const outcomeAndMessage = bucket?.ruleExecution?.outcomeAndMessage?.hits?.hits[0]?._source; + const status = outcomeAndMessage ? outcomeAndMessage?.event?.outcome ?? '' : ''; + const message = + status === 'failure' + ? `${outcomeAndMessage?.message ?? ''} - ${outcomeAndMessage?.error?.message ?? ''}` + : outcomeAndMessage?.message ?? ''; return { id: bucket?.key ?? '', timestamp: bucket?.ruleExecution?.executeStartTime.value_as_string ?? '', duration_ms: durationUs / Millis2Nanos, - status: bucket?.ruleExecution?.outcomeAndMessage?.hits?.hits[0]?._source?.event?.outcome, - message: bucket?.ruleExecution?.outcomeAndMessage?.hits?.hits[0]?._source?.message, + status, + message, num_active_alerts: bucket?.alertCounts?.buckets?.activeAlerts?.doc_count ?? 0, num_new_alerts: bucket?.alertCounts?.buckets?.newAlerts?.doc_count ?? 0, num_recovered_alerts: bucket?.alertCounts?.buckets?.recoveredAlerts?.doc_count ?? 0, @@ -281,10 +271,7 @@ export function formatExecutionLogResult( const { aggregations } = results; if (!aggregations) { - return { - total: 0, - data: [], - }; + return EMPTY_EXECUTION_LOG_RESULT; } const total = (aggregations.executionUuidCardinality as estypes.AggregationsCardinalityAggregate) diff --git a/x-pack/plugins/alerting/server/lib/rule_execution_status.test.ts b/x-pack/plugins/alerting/server/lib/rule_execution_status.test.ts index c6746ed0eac93b..44a9e41c89052f 100644 --- a/x-pack/plugins/alerting/server/lib/rule_execution_status.test.ts +++ b/x-pack/plugins/alerting/server/lib/rule_execution_status.test.ts @@ -34,11 +34,13 @@ describe('RuleExecutionStatus', () => { const status = executionStatusFromState({ alertExecutionStore: { numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, triggeredActionsStatus: ActionsCompletion.COMPLETE, }, } as RuleExecutionState); checkDateIsNearNow(status.lastExecutionDate); expect(status.numberOfTriggeredActions).toBe(0); + expect(status.numberOfScheduledActions).toBe(0); expect(status.status).toBe('ok'); expect(status.error).toBe(undefined); expect(status.warning).toBe(undefined); @@ -49,12 +51,14 @@ describe('RuleExecutionStatus', () => { alertInstances: {}, alertExecutionStore: { numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, triggeredActionsStatus: ActionsCompletion.COMPLETE, }, metrics, }); checkDateIsNearNow(status.lastExecutionDate); expect(status.numberOfTriggeredActions).toBe(0); + expect(status.numberOfScheduledActions).toBe(0); expect(status.status).toBe('ok'); expect(status.error).toBe(undefined); expect(status.warning).toBe(undefined); @@ -66,12 +70,14 @@ describe('RuleExecutionStatus', () => { alertInstances: { a: {} }, alertExecutionStore: { numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, triggeredActionsStatus: ActionsCompletion.COMPLETE, }, metrics, }); checkDateIsNearNow(status.lastExecutionDate); expect(status.numberOfTriggeredActions).toBe(0); + expect(status.numberOfScheduledActions).toBe(0); expect(status.status).toBe('active'); expect(status.error).toBe(undefined); expect(status.warning).toBe(undefined); @@ -82,6 +88,7 @@ describe('RuleExecutionStatus', () => { const status = executionStatusFromState({ alertExecutionStore: { numberOfTriggeredActions: 1, + numberOfScheduledActions: 2, triggeredActionsStatus: ActionsCompletion.COMPLETE, }, alertInstances: { a: {} }, @@ -89,6 +96,7 @@ describe('RuleExecutionStatus', () => { }); checkDateIsNearNow(status.lastExecutionDate); expect(status.numberOfTriggeredActions).toBe(1); + expect(status.numberOfScheduledActions).toBe(2); expect(status.status).toBe('active'); expect(status.error).toBe(undefined); expect(status.warning).toBe(undefined); @@ -313,28 +321,6 @@ describe('RuleExecutionStatus', () => { } `); }); - - test('valid status, date, error, duration and triggeredActions', () => { - const result = ruleExecutionStatusFromRaw(MockLogger, 'rule-id', { - status, - lastExecutionDate: date, - numberOfTriggeredActions: 5, - error, - lastDuration: 1234, - }); - expect(result).toMatchInlineSnapshot(` - Object { - "error": Object { - "message": "wops", - "reason": "execute", - }, - "lastDuration": 1234, - "lastExecutionDate": 2020-09-03T16:26:58.000Z, - "numberOfTriggeredActions": 5, - "status": "active", - } - `); - }); }); }); diff --git a/x-pack/plugins/alerting/server/lib/rule_execution_status.ts b/x-pack/plugins/alerting/server/lib/rule_execution_status.ts index 364975f37614d9..9a446d2383c667 100644 --- a/x-pack/plugins/alerting/server/lib/rule_execution_status.ts +++ b/x-pack/plugins/alerting/server/lib/rule_execution_status.ts @@ -35,6 +35,7 @@ export function executionStatusFromState(state: RuleExecutionState): AlertExecut return { metrics: state.metrics, numberOfTriggeredActions: state.alertExecutionStore.numberOfTriggeredActions, + numberOfScheduledActions: state.alertExecutionStore.numberOfScheduledActions, lastExecutionDate: new Date(), status, ...(hasIncompleteAlertExecution && { @@ -84,7 +85,6 @@ export function ruleExecutionStatusFromRaw( const { lastExecutionDate, lastDuration, - numberOfTriggeredActions, status = 'unknown', error, warning, @@ -107,10 +107,6 @@ export function ruleExecutionStatusFromRaw( executionStatus.lastDuration = lastDuration; } - if (null != numberOfTriggeredActions) { - executionStatus.numberOfTriggeredActions = numberOfTriggeredActions; - } - if (error) { executionStatus.error = error; } diff --git a/x-pack/plugins/alerting/server/routes/get_rule_execution_log.test.ts b/x-pack/plugins/alerting/server/routes/get_rule_execution_log.test.ts index e359e9c52dda04..19a2885dadaf79 100644 --- a/x-pack/plugins/alerting/server/routes/get_rule_execution_log.test.ts +++ b/x-pack/plugins/alerting/server/routes/get_rule_execution_log.test.ts @@ -11,7 +11,7 @@ import { licenseStateMock } from '../lib/license_state.mock'; import { mockHandlerArguments } from './_mock_handler_arguments'; import { SavedObjectsErrorHelpers } from 'src/core/server'; import { rulesClientMock } from '../rules_client.mock'; -import { IExecutionLogResult } from '../lib/get_execution_log_aggregation'; +import { IExecutionLogWithErrorsResult } from '../rules_client'; const rulesClient = rulesClientMock.create(); jest.mock('../lib/license_api_access.ts', () => ({ @@ -24,7 +24,7 @@ beforeEach(() => { describe('getRuleExecutionLogRoute', () => { const dateString = new Date().toISOString(); - const mockedExecutionLog: IExecutionLogResult = { + const mockedExecutionLogWithErrors: IExecutionLogWithErrorsResult = { total: 374, data: [ { @@ -64,6 +64,22 @@ describe('getRuleExecutionLogRoute', () => { schedule_delay_ms: 3008, }, ], + totalErrors: 2, + errors: [ + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.086Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s - an error occurred while running the action executor: something funky with the server log', + }, + { + id: 'c1c04f04-312e-4e23-8e36-e01eb4332ed6', + timestamp: '2022-03-23T17:23:05.249Z', + type: 'alerting', + message: `rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule' - I am erroring in rule execution!!`, + }, + ], }; it('gets rule execution log', async () => { @@ -76,7 +92,7 @@ describe('getRuleExecutionLogRoute', () => { expect(config.path).toMatchInlineSnapshot(`"/internal/alerting/rule/{id}/_execution_log"`); - rulesClient.getExecutionLogForRule.mockResolvedValue(mockedExecutionLog); + rulesClient.getExecutionLogForRule.mockResolvedValue(mockedExecutionLogWithErrors); const [context, req, res] = mockHandlerArguments( { rulesClient }, diff --git a/x-pack/plugins/alerting/server/rules_client/rules_client.ts b/x-pack/plugins/alerting/server/rules_client/rules_client.ts index 4dc1ab6ce11226..ab34158861ad22 100644 --- a/x-pack/plugins/alerting/server/rules_client/rules_client.ts +++ b/x-pack/plugins/alerting/server/rules_client/rules_client.ts @@ -88,10 +88,14 @@ import { AlertingRulesConfig } from '../config'; import { formatExecutionLogResult, getExecutionLogAggregation, - IExecutionLogResult, } from '../lib/get_execution_log_aggregation'; +import { IExecutionLogResult } from '../../common'; import { validateSnoozeDate } from '../lib/validate_snooze_date'; import { RuleMutedError } from '../lib/errors/rule_muted'; +import { + formatExecutionErrorsResult, + IExecutionErrorsResult, +} from '../lib/format_execution_log_errors'; export interface RegistryAlertTypeWithAuth extends RegistryRuleType { authorizedConsumers: string[]; @@ -259,6 +263,7 @@ export interface GetExecutionLogByIdParams { sort: estypes.Sort; } +export type IExecutionLogWithErrorsResult = IExecutionLogResult & IExecutionErrorsResult; interface ScheduleRuleOptions { id: string; consumer: string; @@ -622,7 +627,6 @@ export class RulesClient { entity: AlertingAuthorizationEntity.Rule, }); - // default duration of instance summary is 60 * rule interval const dateNow = new Date(); const durationMillis = parseDuration(rule.schedule.interval) * (numberOfExecutions ?? 60); const defaultDateStart = new Date(dateNow.valueOf() - durationMillis); @@ -688,7 +692,7 @@ export class RulesClient { page, perPage, sort, - }: GetExecutionLogByIdParams): Promise { + }: GetExecutionLogByIdParams): Promise { this.logger.debug(`getExecutionLogForRule(): getting execution log for rule ${id}`); const rule = (await this.get({ id, includeLegacyId: true })) as SanitizedRuleWithLegacyId; @@ -725,23 +729,47 @@ export class RulesClient { const eventLogClient = await this.getEventLogClient(); - const results = await eventLogClient.aggregateEventsBySavedObjectIds( - 'alert', - [id], - { - start: parsedDateStart.toISOString(), - end: parsedDateEnd.toISOString(), - filter, - aggs: getExecutionLogAggregation({ - page, - perPage, - sort, - }), - }, - rule.legacyId !== null ? [rule.legacyId] : undefined - ); + try { + const [aggResult, errorResult] = await Promise.all([ + eventLogClient.aggregateEventsBySavedObjectIds( + 'alert', + [id], + { + start: parsedDateStart.toISOString(), + end: parsedDateEnd.toISOString(), + filter, + aggs: getExecutionLogAggregation({ + page, + perPage, + sort, + }), + }, + rule.legacyId !== null ? [rule.legacyId] : undefined + ), + eventLogClient.findEventsBySavedObjectIds( + 'alert', + [id], + { + start: parsedDateStart.toISOString(), + end: parsedDateEnd.toISOString(), + per_page: 500, + filter: `(event.action:execute AND event.outcome:failure) OR (event.action:execute-timeout)`, + sort: [{ sort_field: '@timestamp', sort_order: 'desc' }], + }, + rule.legacyId !== null ? [rule.legacyId] : undefined + ), + ]); - return formatExecutionLogResult(results); + return { + ...formatExecutionLogResult(aggResult), + ...formatExecutionErrorsResult(errorResult), + }; + } catch (err) { + this.logger.debug( + `rulesClient.getExecutionLogForRule(): error searching event log for rule ${id}: ${err.message}` + ); + throw err; + } } public async find({ diff --git a/x-pack/plugins/alerting/server/rules_client/tests/get_execution_log.test.ts b/x-pack/plugins/alerting/server/rules_client/tests/get_execution_log.test.ts index 8ad904bacd5d3e..53c8884798325b 100644 --- a/x-pack/plugins/alerting/server/rules_client/tests/get_execution_log.test.ts +++ b/x-pack/plugins/alerting/server/rules_client/tests/get_execution_log.test.ts @@ -273,6 +273,313 @@ const aggregateResults = { }, }; +const findResults = { + page: 1, + per_page: 500, + total: 6, + data: [ + { + '@timestamp': '2022-03-23T17:37:07.106Z', + event: { + provider: 'actions', + action: 'execute', + kind: 'action', + start: '2022-03-23T17:37:07.105Z', + end: '2022-03-23T17:37:07.105Z', + duration: 0, + outcome: 'failure', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'action', + id: '9e67b8b0-9e2c-11ec-bd64-774ed95c43ef', + type_id: '.server-log', + }, + { + rel: 'primary', + type: 'alert', + id: 'a348a740-9e2c-11ec-bd64-774ed95c43ef', + type_id: 'example.always-firing', + }, + ], + task: { + scheduled: '2022-03-23T17:37:04.674Z', + schedule_delay: 2431000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + message: 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s', + error: { + message: + 'an error occurred while running the action executor: something funky with the server log', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-23T17:37:07.102Z', + event: { + provider: 'actions', + action: 'execute', + kind: 'action', + start: '2022-03-23T17:37:07.101Z', + end: '2022-03-23T17:37:07.102Z', + duration: 1000000, + outcome: 'failure', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'action', + id: '9e67b8b0-9e2c-11ec-bd64-774ed95c43ef', + type_id: '.server-log', + }, + { + rel: 'primary', + type: 'alert', + id: 'a348a740-9e2c-11ec-bd64-774ed95c43ef', + type_id: 'example.always-firing', + }, + ], + task: { + scheduled: '2022-03-23T17:37:04.676Z', + schedule_delay: 2425000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + message: 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s', + error: { + message: + 'an error occurred while running the action executor: something funky with the server log', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-23T17:37:07.098Z', + event: { + provider: 'actions', + action: 'execute', + kind: 'action', + start: '2022-03-23T17:37:07.098Z', + end: '2022-03-23T17:37:07.098Z', + duration: 0, + outcome: 'failure', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'action', + id: '9e67b8b0-9e2c-11ec-bd64-774ed95c43ef', + type_id: '.server-log', + }, + { + rel: 'primary', + type: 'alert', + id: 'a348a740-9e2c-11ec-bd64-774ed95c43ef', + type_id: 'example.always-firing', + }, + ], + task: { + scheduled: '2022-03-23T17:37:04.673Z', + schedule_delay: 2425000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + message: 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s', + error: { + message: + 'an error occurred while running the action executor: something funky with the server log', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-23T17:37:07.096Z', + event: { + provider: 'actions', + action: 'execute', + kind: 'action', + start: '2022-03-23T17:37:07.095Z', + end: '2022-03-23T17:37:07.096Z', + duration: 1000000, + outcome: 'failure', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'action', + id: '9e67b8b0-9e2c-11ec-bd64-774ed95c43ef', + type_id: '.server-log', + }, + { + rel: 'primary', + type: 'alert', + id: 'a348a740-9e2c-11ec-bd64-774ed95c43ef', + type_id: 'example.always-firing', + }, + ], + task: { + scheduled: '2022-03-23T17:37:04.677Z', + schedule_delay: 2418000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + message: 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s', + error: { + message: + 'an error occurred while running the action executor: something funky with the server log', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-23T17:37:07.086Z', + event: { + provider: 'actions', + action: 'execute', + kind: 'action', + start: '2022-03-23T17:37:07.084Z', + end: '2022-03-23T17:37:07.086Z', + duration: 2000000, + outcome: 'failure', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'action', + id: '9e67b8b0-9e2c-11ec-bd64-774ed95c43ef', + type_id: '.server-log', + }, + { + rel: 'primary', + type: 'alert', + id: 'a348a740-9e2c-11ec-bd64-774ed95c43ef', + type_id: 'example.always-firing', + }, + ], + task: { + scheduled: '2022-03-23T17:37:04.678Z', + schedule_delay: 2406000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + message: 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s', + error: { + message: + 'an error occurred while running the action executor: something funky with the server log', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-23T17:23:05.249Z', + event: { + provider: 'alerting', + action: 'execute', + kind: 'alert', + category: ['AlertingExample'], + start: '2022-03-23T17:23:05.131Z', + outcome: 'failure', + end: '2022-03-23T17:23:05.248Z', + duration: 117000000, + reason: 'execute', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: 'c1c04f04-312e-4e23-8e36-e01eb4332ed6', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'a348a740-9e2c-11ec-bd64-774ed95c43ef', + type_id: 'example.always-firing', + }, + ], + task: { + scheduled: '2022-03-23T17:22:23.618Z', + schedule_delay: 41512000000, + }, + alerting: { + status: 'error', + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + rule: { + id: 'a348a740-9e2c-11ec-bd64-774ed95c43ef', + license: 'basic', + category: 'example.always-firing', + ruleset: 'AlertingExample', + }, + message: + "rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule'", + error: { + message: 'I am erroring in rule execution!!', + }, + ecs: { + version: '1.8.0', + }, + }, + ], +}; + function getRuleSavedObject(attributes: Partial = {}): SavedObject { return { ...BaseRuleSavedObject, @@ -301,6 +608,7 @@ describe('getExecutionLogForRule()', () => { const ruleSO = getRuleSavedObject({}); unsecuredSavedObjectsClient.get.mockResolvedValueOnce(ruleSO); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); const result = await rulesClient.getExecutionLogForRule(getExecutionLogByIdParams()); expect(result).toEqual({ @@ -343,6 +651,50 @@ describe('getExecutionLogForRule()', () => { schedule_delay_ms: 3345, }, ], + totalErrors: 6, + errors: [ + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.106Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s - an error occurred while running the action executor: something funky with the server log', + }, + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.102Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s - an error occurred while running the action executor: something funky with the server log', + }, + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.098Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s - an error occurred while running the action executor: something funky with the server log', + }, + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.096Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s - an error occurred while running the action executor: something funky with the server log', + }, + { + id: '08d9b0f5-0b41-47c9-951f-a666b5788ddc', + timestamp: '2022-03-23T17:37:07.086Z', + type: 'actions', + message: + 'action execution failure: .server-log:9e67b8b0-9e2c-11ec-bd64-774ed95c43ef: s - an error occurred while running the action executor: something funky with the server log', + }, + { + id: 'c1c04f04-312e-4e23-8e36-e01eb4332ed6', + timestamp: '2022-03-23T17:23:05.249Z', + type: 'alerting', + message: `rule execution failure: example.always-firing:a348a740-9e2c-11ec-bd64-774ed95c43ef: 'test rule' - I am erroring in rule execution!!`, + }, + ], }); }); @@ -353,6 +705,7 @@ describe('getExecutionLogForRule()', () => { test('calls saved objects and event log client with default params', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); await rulesClient.getExecutionLogForRule(getExecutionLogByIdParams()); @@ -372,6 +725,19 @@ describe('getExecutionLogForRule()', () => { }, undefined, ]); + expect(eventLogClient.findEventsBySavedObjectIds).toHaveBeenCalledTimes(1); + expect(eventLogClient.findEventsBySavedObjectIds.mock.calls[0]).toEqual([ + 'alert', + ['1'], + { + per_page: 500, + filter: `(event.action:execute AND event.outcome:failure) OR (event.action:execute-timeout)`, + sort: [{ sort_field: '@timestamp', sort_order: 'desc' }], + end: mockedDateString, + start: '2019-02-12T20:01:22.479Z', + }, + undefined, + ]); }); test('calls event log client with legacy ids param', async () => { @@ -379,6 +745,7 @@ describe('getExecutionLogForRule()', () => { getRuleSavedObject({ legacyId: '99999' }) ); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); await rulesClient.getExecutionLogForRule(getExecutionLogByIdParams()); @@ -398,11 +765,25 @@ describe('getExecutionLogForRule()', () => { }, ['99999'], ]); + expect(eventLogClient.findEventsBySavedObjectIds).toHaveBeenCalledTimes(1); + expect(eventLogClient.findEventsBySavedObjectIds.mock.calls[0]).toEqual([ + 'alert', + ['1'], + { + per_page: 500, + filter: `(event.action:execute AND event.outcome:failure) OR (event.action:execute-timeout)`, + sort: [{ sort_field: '@timestamp', sort_order: 'desc' }], + end: mockedDateString, + start: '2019-02-12T20:01:22.479Z', + }, + ['99999'], + ]); }); test('calls event log client with end date if specified', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); await rulesClient.getExecutionLogForRule( getExecutionLogByIdParams({ dateEnd: new Date(Date.now() - 2700000).toISOString() }) @@ -424,11 +805,25 @@ describe('getExecutionLogForRule()', () => { }, undefined, ]); + expect(eventLogClient.findEventsBySavedObjectIds).toHaveBeenCalledTimes(1); + expect(eventLogClient.findEventsBySavedObjectIds.mock.calls[0]).toEqual([ + 'alert', + ['1'], + { + per_page: 500, + filter: `(event.action:execute AND event.outcome:failure) OR (event.action:execute-timeout)`, + sort: [{ sort_field: '@timestamp', sort_order: 'desc' }], + end: '2019-02-12T20:16:22.479Z', + start: '2019-02-12T20:01:22.479Z', + }, + undefined, + ]); }); test('calls event log client with filter if specified', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); await rulesClient.getExecutionLogForRule( getExecutionLogByIdParams({ filter: 'event.outcome: success' }) @@ -451,11 +846,25 @@ describe('getExecutionLogForRule()', () => { }, undefined, ]); + expect(eventLogClient.findEventsBySavedObjectIds).toHaveBeenCalledTimes(1); + expect(eventLogClient.findEventsBySavedObjectIds.mock.calls[0]).toEqual([ + 'alert', + ['1'], + { + per_page: 500, + filter: `(event.action:execute AND event.outcome:failure) OR (event.action:execute-timeout)`, + sort: [{ sort_field: '@timestamp', sort_order: 'desc' }], + end: mockedDateString, + start: '2019-02-12T20:01:22.479Z', + }, + undefined, + ]); }); test('invalid start date throws an error', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); const dateStart = 'ain"t no way this will get parsed as a date'; expect( @@ -468,6 +877,7 @@ describe('getExecutionLogForRule()', () => { test('invalid end date throws an error', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); const dateEnd = 'ain"t no way this will get parsed as a date'; expect( @@ -480,6 +890,7 @@ describe('getExecutionLogForRule()', () => { test('invalid page value throws an error', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); expect( rulesClient.getExecutionLogForRule(getExecutionLogByIdParams({ page: -3 })) @@ -489,6 +900,7 @@ describe('getExecutionLogForRule()', () => { test('invalid perPage value throws an error', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); expect( rulesClient.getExecutionLogForRule(getExecutionLogByIdParams({ perPage: -3 })) @@ -498,6 +910,7 @@ describe('getExecutionLogForRule()', () => { test('invalid sort value throws an error', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); expect( rulesClient.getExecutionLogForRule( @@ -511,6 +924,7 @@ describe('getExecutionLogForRule()', () => { test('throws error when saved object get throws an error', async () => { unsecuredSavedObjectsClient.get.mockRejectedValueOnce(new Error('OMG!')); eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); expect( rulesClient.getExecutionLogForRule(getExecutionLogByIdParams()) @@ -520,12 +934,23 @@ describe('getExecutionLogForRule()', () => { test('throws error when eventLog.aggregateEventsBySavedObjectIds throws an error', async () => { unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); eventLogClient.aggregateEventsBySavedObjectIds.mockRejectedValueOnce(new Error('OMG 2!')); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); expect( rulesClient.getExecutionLogForRule(getExecutionLogByIdParams()) ).rejects.toMatchInlineSnapshot(`[Error: OMG 2!]`); }); + test('throws error when eventLog.findEventsBySavedObjectIds throws an error', async () => { + unsecuredSavedObjectsClient.get.mockResolvedValueOnce(getRuleSavedObject()); + eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockRejectedValueOnce(new Error('OMG 3!')); + + expect( + rulesClient.getExecutionLogForRule(getExecutionLogByIdParams()) + ).rejects.toMatchInlineSnapshot(`[Error: OMG 3!]`); + }); + describe('authorization', () => { beforeEach(() => { const ruleSO = getRuleSavedObject({}); @@ -534,6 +959,7 @@ describe('getExecutionLogForRule()', () => { test('ensures user is authorised to get this type of alert under the consumer', async () => { eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); await rulesClient.getExecutionLogForRule(getExecutionLogByIdParams()); expect(authorization.ensureAuthorized).toHaveBeenCalledWith({ @@ -570,6 +996,7 @@ describe('getExecutionLogForRule()', () => { test('logs audit event when getting a rule execution log', async () => { eventLogClient.aggregateEventsBySavedObjectIds.mockResolvedValueOnce(aggregateResults); + eventLogClient.findEventsBySavedObjectIds.mockResolvedValueOnce(findResults); await rulesClient.getExecutionLogForRule(getExecutionLogByIdParams()); expect(auditLogger.log).toHaveBeenCalledWith( expect.objectContaining({ diff --git a/x-pack/plugins/alerting/server/task_runner/create_execution_handler.test.ts b/x-pack/plugins/alerting/server/task_runner/create_execution_handler.test.ts index 7d02535566caca..8b97bf9266e9a6 100644 --- a/x-pack/plugins/alerting/server/task_runner/create_execution_handler.test.ts +++ b/x-pack/plugins/alerting/server/task_runner/create_execution_handler.test.ts @@ -127,6 +127,7 @@ describe('Create Execution Handler', () => { ); alertExecutionStore = { numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, triggeredActionsStatus: ActionsCompletion.COMPLETE, }; }); @@ -512,6 +513,7 @@ describe('Create Execution Handler', () => { alertExecutionStore = { numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, triggeredActionsStatus: ActionsCompletion.COMPLETE, }; @@ -524,6 +526,7 @@ describe('Create Execution Handler', () => { }); expect(alertExecutionStore.numberOfTriggeredActions).toBe(2); + expect(alertExecutionStore.numberOfScheduledActions).toBe(3); expect(alertExecutionStore.triggeredActionsStatus).toBe(ActionsCompletion.PARTIAL); expect(actionsClient.enqueueExecution).toHaveBeenCalledTimes(2); }); diff --git a/x-pack/plugins/alerting/server/task_runner/create_execution_handler.ts b/x-pack/plugins/alerting/server/task_runner/create_execution_handler.ts index 253099957f8d33..56e1a25cb0655a 100644 --- a/x-pack/plugins/alerting/server/task_runner/create_execution_handler.ts +++ b/x-pack/plugins/alerting/server/task_runner/create_execution_handler.ts @@ -112,6 +112,8 @@ export function createExecutionHandler< }), })); + alertExecutionStore.numberOfScheduledActions += actions.length; + const ruleLabel = `${ruleType.id}:${ruleId}: '${ruleName}'`; const actionsClient = await actionsPlugin.getActionsClientWithRequest(request); diff --git a/x-pack/plugins/alerting/server/task_runner/fixtures.ts b/x-pack/plugins/alerting/server/task_runner/fixtures.ts index 4e38be4834c860..d8db61cdddc0dd 100644 --- a/x-pack/plugins/alerting/server/task_runner/fixtures.ts +++ b/x-pack/plugins/alerting/server/task_runner/fixtures.ts @@ -211,6 +211,7 @@ export const generateEventLog = ({ actionId, status, numberOfTriggeredActions, + numberOfScheduledActions, savedObjects = [generateAlertSO('1')], }: GeneratorParams = {}) => ({ ...(status === 'error' && { @@ -234,9 +235,10 @@ export const generateEventLog = ({ ...(consumer && { consumer }), execution: { uuid: '5f6aa57d-3e22-484e-bae8-cbed868f4d28', - ...(!isNil(numberOfTriggeredActions) && { + ...((!isNil(numberOfTriggeredActions) || !isNil(numberOfScheduledActions)) && { metrics: { number_of_triggered_actions: numberOfTriggeredActions, + number_of_scheduled_actions: numberOfScheduledActions, number_of_searches: 3, es_search_duration_ms: 33, total_search_duration_ms: 23423, diff --git a/x-pack/plugins/alerting/server/task_runner/task_runner.test.ts b/x-pack/plugins/alerting/server/task_runner/task_runner.test.ts index 2227a34dfa1112..3eed02bb10e312 100644 --- a/x-pack/plugins/alerting/server/task_runner/task_runner.test.ts +++ b/x-pack/plugins/alerting/server/task_runner/task_runner.test.ts @@ -232,7 +232,7 @@ describe('Task Runner', () => { expect(logger.debug).nthCalledWith(1, 'executing rule test:1 at 1970-01-01T00:00:00.000Z'); expect(logger.debug).nthCalledWith( 2, - 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":0,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"ok"}' + 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":0,"numberOfScheduledActions":0,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"ok"}' ); const eventLogger = taskRunnerFactoryInitializerParams.eventLogger; @@ -312,7 +312,7 @@ describe('Task Runner', () => { ); expect(logger.debug).nthCalledWith( 3, - 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":1,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' + 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":1,"numberOfScheduledActions":1,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' ); const eventLogger = customTaskRunnerFactoryInitializerParams.eventLogger; @@ -368,6 +368,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 1, + numberOfScheduledActions: 1, task: true, consumer: 'bar', }) @@ -419,7 +420,7 @@ describe('Task Runner', () => { ); expect(logger.debug).nthCalledWith( 4, - 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":0,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' + 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":0,"numberOfScheduledActions":0,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' ); const eventLogger = taskRunnerFactoryInitializerParams.eventLogger; @@ -462,6 +463,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, task: true, consumer: 'bar', }) @@ -583,7 +585,7 @@ describe('Task Runner', () => { ); expect(logger.debug).nthCalledWith( 4, - 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":1,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' + 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":1,"numberOfScheduledActions":1,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' ); expect(mockUsageCounter.incrementCounter).not.toHaveBeenCalled(); } @@ -772,6 +774,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, task: true, consumer: 'bar', }) @@ -836,6 +839,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 1, + numberOfScheduledActions: 1, task: true, consumer: 'bar', }) @@ -909,6 +913,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 1, + numberOfScheduledActions: 1, task: true, consumer: 'bar', }) @@ -1026,6 +1031,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 1, + numberOfScheduledActions: 1, task: true, consumer: 'bar', }) @@ -1107,7 +1113,7 @@ describe('Task Runner', () => { ); expect(logger.debug).nthCalledWith( 4, - 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":2,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' + 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":2,"numberOfScheduledActions":2,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' ); const eventLogger = customTaskRunnerFactoryInitializerParams.eventLogger; @@ -1174,6 +1180,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 2, + numberOfScheduledActions: 2, task: true, consumer: 'bar', }) @@ -1247,7 +1254,7 @@ describe('Task Runner', () => { ); expect(logger.debug).nthCalledWith( 4, - `ruleExecutionStatus for test:${alertId}: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":2,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}` + `ruleExecutionStatus for test:${alertId}: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":2,"numberOfScheduledActions":2,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}` ); const eventLogger = customTaskRunnerFactoryInitializerParams.eventLogger; @@ -1435,6 +1442,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 0, + numberOfScheduledActions: 2, task: true, consumer: 'bar', }) @@ -2040,6 +2048,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, task: true, consumer: 'bar', }) @@ -2142,6 +2151,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'active', numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, task: true, consumer: 'bar', }) @@ -2233,6 +2243,7 @@ describe('Task Runner', () => { status: 'active', consumer: 'bar', numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, task: true, }) ); @@ -2322,6 +2333,7 @@ describe('Task Runner', () => { status: 'ok', consumer: 'bar', numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, task: true, }) ); @@ -2407,6 +2419,7 @@ describe('Task Runner', () => { status: 'ok', consumer: 'bar', numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, task: true, }) ); @@ -2468,7 +2481,7 @@ describe('Task Runner', () => { expect(logger.debug).nthCalledWith(1, 'executing rule test:1 at 1970-01-01T00:00:00.000Z'); expect(logger.debug).nthCalledWith( 2, - 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":0,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"ok"}' + 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":0,"numberOfScheduledActions":0,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"ok"}' ); const eventLogger = taskRunnerFactoryInitializerParams.eventLogger; @@ -2657,35 +2670,37 @@ describe('Task Runner', () => { } ); + const mockActions = [ + { + group: 'default', + id: '1', + actionTypeId: 'action', + }, + { + group: 'default', + id: '2', + actionTypeId: 'action', + }, + { + group: 'default', + id: '3', + actionTypeId: 'action', + }, + { + group: 'default', + id: '4', + actionTypeId: 'action', + }, + { + group: 'default', + id: '5', + actionTypeId: 'action', + }, + ]; + rulesClient.get.mockResolvedValue({ ...mockedRuleTypeSavedObject, - actions: [ - { - group: 'default', - id: '1', - actionTypeId: 'action', - }, - { - group: 'default', - id: '2', - actionTypeId: 'action', - }, - { - group: 'default', - id: '3', - actionTypeId: 'action', - }, - { - group: 'default', - id: '4', - actionTypeId: 'action', - }, - { - group: 'default', - id: '5', - actionTypeId: 'action', - }, - ], + actions: mockActions, } as jest.ResolvedValue); ruleTypeRegistry.get.mockReturnValue(ruleTypeWithConfig); encryptedSavedObjectsClient.getDecryptedAsInternalUser.mockResolvedValueOnce(SAVED_OBJECT); @@ -2801,6 +2816,7 @@ describe('Task Runner', () => { outcome: 'success', status: 'warning', numberOfTriggeredActions: ruleTypeWithConfig.config.execution.actions.max, + numberOfScheduledActions: mockActions.length, reason: AlertExecutionStatusWarningReasons.MAX_EXECUTABLE_ACTIONS, task: true, consumer: 'bar', diff --git a/x-pack/plugins/alerting/server/task_runner/task_runner.ts b/x-pack/plugins/alerting/server/task_runner/task_runner.ts index b7980f612e7b9a..1ddca46d174186 100644 --- a/x-pack/plugins/alerting/server/task_runner/task_runner.ts +++ b/x-pack/plugins/alerting/server/task_runner/task_runner.ts @@ -492,6 +492,7 @@ export class TaskRunner< const alertExecutionStore: AlertExecutionStore = { numberOfTriggeredActions: 0, + numberOfScheduledActions: 0, triggeredActionsStatus: ActionsCompletion.COMPLETE, }; @@ -816,7 +817,12 @@ export class TaskRunner< set( event, 'kibana.alert.rule.execution.metrics.number_of_triggered_actions', - executionStatus.numberOfTriggeredActions ?? 0 + executionStatus.numberOfTriggeredActions + ); + set( + event, + 'kibana.alert.rule.execution.metrics.number_of_scheduled_actions', + executionStatus.numberOfScheduledActions ); } diff --git a/x-pack/plugins/alerting/server/task_runner/task_runner_cancel.test.ts b/x-pack/plugins/alerting/server/task_runner/task_runner_cancel.test.ts index e60e4e9295a5c9..39d2aa8418394e 100644 --- a/x-pack/plugins/alerting/server/task_runner/task_runner_cancel.test.ts +++ b/x-pack/plugins/alerting/server/task_runner/task_runner_cancel.test.ts @@ -330,6 +330,7 @@ describe('Task Runner Cancel', () => { metrics: { number_of_searches: 3, number_of_triggered_actions: 0, + number_of_scheduled_actions: 0, es_search_duration_ms: 33, total_search_duration_ms: 23423, }, @@ -519,7 +520,7 @@ describe('Task Runner Cancel', () => { ); expect(logger.debug).nthCalledWith( 7, - 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":0,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' + 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":0,"numberOfScheduledActions":0,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' ); const eventLogger = taskRunnerFactoryInitializerParams.eventLogger; @@ -613,6 +614,7 @@ describe('Task Runner Cancel', () => { metrics: { number_of_searches: 3, number_of_triggered_actions: 0, + number_of_scheduled_actions: 0, es_search_duration_ms: 33, total_search_duration_ms: 23423, }, @@ -678,7 +680,7 @@ describe('Task Runner Cancel', () => { ); expect(logger.debug).nthCalledWith( 6, - 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":1,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' + 'ruleExecutionStatus for test:1: {"metrics":{"numSearches":3,"esSearchDurationMs":33,"totalSearchDurationMs":23423},"numberOfTriggeredActions":1,"numberOfScheduledActions":1,"lastExecutionDate":"1970-01-01T00:00:00.000Z","status":"active"}' ); const eventLogger = taskRunnerFactoryInitializerParams.eventLogger; @@ -891,6 +893,7 @@ describe('Task Runner Cancel', () => { metrics: { number_of_searches: 3, number_of_triggered_actions: 1, + number_of_scheduled_actions: 1, es_search_duration_ms: 33, total_search_duration_ms: 23423, }, diff --git a/x-pack/plugins/alerting/server/task_runner/types.ts b/x-pack/plugins/alerting/server/task_runner/types.ts index 00878c2980a8c0..d8483139a92b96 100644 --- a/x-pack/plugins/alerting/server/task_runner/types.ts +++ b/x-pack/plugins/alerting/server/task_runner/types.ts @@ -163,5 +163,6 @@ export enum ActionsCompletion { export interface AlertExecutionStore { numberOfTriggeredActions: number; + numberOfScheduledActions: number; triggeredActionsStatus: ActionsCompletion; } diff --git a/x-pack/plugins/alerting/server/types.ts b/x-pack/plugins/alerting/server/types.ts index 8dcc4036135775..37df778b6185a2 100644 --- a/x-pack/plugins/alerting/server/types.ts +++ b/x-pack/plugins/alerting/server/types.ts @@ -195,7 +195,6 @@ export interface AlertMeta extends SavedObjectAttributes { // delete any previous error if the current status has no error export interface RawRuleExecutionStatus extends SavedObjectAttributes { status: AlertExecutionStatuses; - numberOfTriggeredActions?: number; lastExecutionDate: string; lastDuration?: number; error: null | { diff --git a/x-pack/plugins/apm/common/fleet.ts b/x-pack/plugins/apm/common/fleet.ts index 46ec9be784f43f..ed148b2230011a 100644 --- a/x-pack/plugins/apm/common/fleet.ts +++ b/x-pack/plugins/apm/common/fleet.ts @@ -4,14 +4,61 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import semverParse from 'semver/functions/parse'; - export const POLICY_ELASTIC_AGENT_ON_CLOUD = 'policy-elastic-agent-on-cloud'; -export const SUPPORTED_APM_PACKAGE_VERSION = '8.1.0'; +export const INPUT_VAR_NAME_TO_SCHEMA_PATH: Record = { + host: 'apm-server.host', + url: 'apm-server.url', + enable_rum: 'apm-server.rum.enabled', + default_service_environment: 'apm-server.default_service_environment', + rum_allow_origins: 'apm-server.rum.allow_origins', + rum_allow_headers: 'apm-server.rum.allow_headers', + rum_event_rate_limit: 'apm-server.rum.event_rate.limit', + rum_allow_service_names: 'apm-server.rum.allow_service_names', + rum_event_rate_lru_size: 'apm-server.rum.event_rate.lru_size', + rum_response_headers: 'apm-server.rum.response_headers', + rum_library_pattern: 'apm-server.rum.library_pattern', + rum_exclude_from_grouping: 'apm-server.rum.exclude_from_grouping', + max_event_bytes: 'apm-server.max_event_size', + capture_personal_data: 'apm-server.capture_personal_data', + max_header_bytes: 'apm-server.max_header_size', + idle_timeout: 'apm-server.idle_timeout', + read_timeout: 'apm-server.read_timeout', + shutdown_timeout: 'apm-server.shutdown_timeout', + write_timeout: 'apm-server.write_timeout', + max_connections: 'apm-server.max_connections', + response_headers: 'apm-server.response_headers', + expvar_enabled: 'apm-server.expvar.enabled', + tls_enabled: 'apm-server.ssl.enabled', + tls_certificate: 'apm-server.ssl.certificate', + tls_key: 'apm-server.ssl.key', + tls_supported_protocols: 'apm-server.ssl.supported_protocols', + tls_cipher_suites: 'apm-server.ssl.cipher_suites', + tls_curve_types: 'apm-server.ssl.curve_types', + secret_token: 'apm-server.auth.secret_token', + api_key_enabled: 'apm-server.auth.api_key.enabled', + api_key_limit: 'apm-server.auth.api_key.limit', + anonymous_enabled: 'apm-server.auth.anonymous.enabled', + anonymous_allow_agent: 'apm-server.auth.anonymous.allow_agent', + anonymous_allow_service: 'apm-server.auth.anonymous.allow_service', + anonymous_rate_limit_ip_limit: + 'apm-server.auth.anonymous.rate_limit.ip_limit', + anonymous_rate_limit_event_limit: + 'apm-server.auth.anonymous.rate_limit.event_limit', + tail_sampling_enabled: 'apm-server.sampling.tail.enabled', + tail_sampling_interval: 'apm-server.sampling.tail.interval', + tail_sampling_policies: 'apm-server.sampling.tail.policies', +}; -export function isPrereleaseVersion(version: string) { - return semverParse(version)?.prerelease?.length ?? 0 > 0; -} +export const LEGACY_TO_CURRENT_SCHEMA_PATHS: Record = { + 'apm-server.rum.event_rate.limit': + 'apm-server.auth.anonymous.rate_limit.event_limit', + 'apm-server.rum.event_rate.lru_size': + 'apm-server.auth.anonymous.rate_limit.ip_limit', + 'apm-server.rum.allow_service_names': + 'apm-server.auth.anonymous.allow_service', + 'apm-server.secret_token': 'apm-server.auth.secret_token', + 'apm-server.api_key.enabled': 'apm-server.auth.api_key.enabled', +}; export const ELASTIC_CLOUD_APM_AGENT_POLICY_ID = 'elastic-cloud-apm'; diff --git a/x-pack/plugins/apm/common/service_inventory.ts b/x-pack/plugins/apm/common/service_inventory.ts index b7c8c0ea90a587..022980b6c8193c 100644 --- a/x-pack/plugins/apm/common/service_inventory.ts +++ b/x-pack/plugins/apm/common/service_inventory.ts @@ -18,3 +18,13 @@ export interface ServiceListItem { transactionErrorRate?: number | null; environments?: string[]; } + +export enum ServiceInventoryFieldName { + ServiceName = 'serviceName', + HealthStatus = 'healthStatus', + Environments = 'environments', + TransactionType = 'transactionType', + Throughput = 'throughput', + Latency = 'latency', + TransactionErrorRate = 'transactionErrorRate', +} diff --git a/x-pack/plugins/apm/public/components/alerting/fields.tsx b/x-pack/plugins/apm/public/components/alerting/fields.tsx index 4abbd97d98db46..9ea3c5aa2a6bde 100644 --- a/x-pack/plugins/apm/public/components/alerting/fields.tsx +++ b/x-pack/plugins/apm/public/components/alerting/fields.tsx @@ -39,12 +39,9 @@ export function ServiceField({ > ); + const mainStatisticsItems = mainStatisticsFetch.data?.items ?? []; + const preloadedServices = sortedAndFilteredServicesFetch.data?.services || []; + + const displayHealthStatus = [ + ...mainStatisticsItems, + ...preloadedServices, + ].some((item) => 'healthStatus' in item); + + const tiebreakerField = useKibana().services.uiSettings?.get( + apmServiceInventoryOptimizedSorting + ) + ? ServiceInventoryFieldName.ServiceName + : ServiceInventoryFieldName.Throughput; + + const initialSortField = displayHealthStatus + ? ServiceInventoryFieldName.HealthStatus + : tiebreakerField; + + const initialSortDirection = + initialSortField === ServiceInventoryFieldName.ServiceName ? 'asc' : 'desc'; + const items = joinByKey( [ - ...(sortedAndFilteredServicesFetch.data?.services ?? []), - ...(mainStatisticsFetch.data?.items ?? []), + // only use preloaded services if tiebreaker field is service.name, + // otherwise ignore them to prevent re-sorting of the table + // once the tiebreaking metric comes in + ...(tiebreakerField === ServiceInventoryFieldName.ServiceName + ? preloadedServices + : []), + ...mainStatisticsItems, ], 'serviceName' ); @@ -187,6 +217,17 @@ export function ServiceInventory() { comparisonFetch.status === FETCH_STATUS.LOADING || comparisonFetch.status === FETCH_STATUS.NOT_INITIATED } + displayHealthStatus={displayHealthStatus} + initialSortField={initialSortField} + initialSortDirection={initialSortDirection} + sortFn={(itemsToSort, sortField, sortDirection) => { + return orderServiceItems({ + items: itemsToSort, + primarySortField: sortField, + sortDirection, + tiebreakerField, + }); + }} comparisonData={comparisonFetch?.data} noItemsMessage={noItemsMessage} /> diff --git a/x-pack/plugins/apm/public/components/app/service_inventory/service_list/index.tsx b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/index.tsx index cc43be6a790ea8..7bf340bed12a96 100644 --- a/x-pack/plugins/apm/public/components/app/service_inventory/service_list/index.tsx +++ b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/index.tsx @@ -15,7 +15,6 @@ import { } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { TypeOf } from '@kbn/typed-react-router-config'; -import { orderBy } from 'lodash'; import React, { useMemo } from 'react'; import { NOT_AVAILABLE_LABEL } from '../../../../../common/i18n'; import { ServiceHealthStatus } from '../../../../../common/service_health_status'; @@ -45,7 +44,10 @@ import { getTimeSeriesColor, } from '../../../shared/charts/helper/get_timeseries_color'; import { HealthBadge } from './health_badge'; -import { ServiceListItem } from '../../../../../common/service_inventory'; +import { + ServiceInventoryFieldName, + ServiceListItem, +} from '../../../../../common/service_inventory'; type ServicesDetailedStatisticsAPIResponse = APIReturnType<'GET /internal/apm/services/detailed_statistics'>; @@ -54,13 +56,6 @@ function formatString(value?: string | null) { return value || NOT_AVAILABLE_LABEL; } -const SERVICE_HEALTH_STATUS_ORDER = [ - ServiceHealthStatus.unknown, - ServiceHealthStatus.healthy, - ServiceHealthStatus.warning, - ServiceHealthStatus.critical, -]; - export function getServiceColumns({ query, showTransactionTypeColumn, @@ -84,7 +79,7 @@ export function getServiceColumns({ ...(showHealthStatusColumn ? [ { - field: 'healthStatus', + field: ServiceInventoryFieldName.HealthStatus, name: i18n.translate('xpack.apm.servicesTable.healthColumnLabel', { defaultMessage: 'Health', }), @@ -101,7 +96,7 @@ export function getServiceColumns({ ] : []), { - field: 'serviceName', + field: ServiceInventoryFieldName.ServiceName, name: i18n.translate('xpack.apm.servicesTable.nameColumnLabel', { defaultMessage: 'Name', }), @@ -123,7 +118,7 @@ export function getServiceColumns({ ...(showWhenSmallOrGreaterThanLarge ? [ { - field: 'environments', + field: ServiceInventoryFieldName.Environments, name: i18n.translate( 'xpack.apm.servicesTable.environmentColumnLabel', { @@ -141,7 +136,7 @@ export function getServiceColumns({ ...(showTransactionTypeColumn && showWhenSmallOrGreaterThanXL ? [ { - field: 'transactionType', + field: ServiceInventoryFieldName.TransactionType, name: i18n.translate( 'xpack.apm.servicesTable.transactionColumnLabel', { defaultMessage: 'Transaction type' } @@ -152,7 +147,7 @@ export function getServiceColumns({ ] : []), { - field: 'latency', + field: ServiceInventoryFieldName.Latency, name: i18n.translate('xpack.apm.servicesTable.latencyAvgColumnLabel', { defaultMessage: 'Latency (avg.)', }), @@ -179,7 +174,7 @@ export function getServiceColumns({ align: RIGHT_ALIGNMENT, }, { - field: 'throughput', + field: ServiceInventoryFieldName.Throughput, name: i18n.translate('xpack.apm.servicesTable.throughputColumnLabel', { defaultMessage: 'Throughput', }), @@ -207,7 +202,7 @@ export function getServiceColumns({ align: RIGHT_ALIGNMENT, }, { - field: 'transactionErrorRate', + field: ServiceInventoryFieldName.TransactionErrorRate, name: i18n.translate('xpack.apm.servicesTable.transactionErrorRate', { defaultMessage: 'Failed transaction rate', }), @@ -246,6 +241,14 @@ interface Props { noItemsMessage?: React.ReactNode; isLoading: boolean; isFailure?: boolean; + displayHealthStatus: boolean; + initialSortField: ServiceInventoryFieldName; + initialSortDirection: 'asc' | 'desc'; + sortFn: ( + sortItems: ServiceListItem[], + sortField: ServiceInventoryFieldName, + sortDirection: 'asc' | 'desc' + ) => ServiceListItem[]; } export function ServiceList({ @@ -255,9 +258,12 @@ export function ServiceList({ comparisonData, isLoading, isFailure, + displayHealthStatus, + initialSortField, + initialSortDirection, + sortFn, }: Props) { const breakpoints = useBreakpoints(); - const displayHealthStatus = items.some((item) => 'healthStatus' in item); const showTransactionTypeColumn = items.some( ({ transactionType }) => @@ -292,9 +298,6 @@ export function ServiceList({ ] ); - const initialSortField = displayHealthStatus ? 'healthStatus' : 'serviceName'; - const initialSortDirection = displayHealthStatus ? 'desc' : 'asc'; - return ( @@ -333,7 +336,7 @@ export function ServiceList({ - isLoading={isLoading} error={isFailure} columns={serviceColumns} @@ -341,41 +344,13 @@ export function ServiceList({ noItemsMessage={noItemsMessage} initialSortField={initialSortField} initialSortDirection={initialSortDirection} - sortFn={(itemsToSort, sortField, sortDirection) => { - // For healthStatus, sort items by healthStatus first, then by name - return sortField === 'healthStatus' - ? orderBy( - itemsToSort, - [ - (item) => { - return item.healthStatus - ? SERVICE_HEALTH_STATUS_ORDER.indexOf(item.healthStatus) - : -1; - }, - (item) => item.serviceName.toLowerCase(), - ], - [sortDirection, sortDirection === 'asc' ? 'desc' : 'asc'] - ) - : orderBy( - itemsToSort, - (item) => { - switch (sortField) { - // Use `?? -1` here so `undefined` will appear after/before `0`. - // In the table this will make the "N/A" items always at the - // bottom/top. - case 'latency': - return item.latency ?? -1; - case 'throughput': - return item.throughput ?? -1; - case 'transactionErrorRate': - return item.transactionErrorRate ?? -1; - default: - return item[sortField as keyof typeof item]; - } - }, - sortDirection - ); - }} + sortFn={(itemsToSort, sortField, sortDirection) => + sortFn( + itemsToSort, + sortField as ServiceInventoryFieldName, + sortDirection + ) + } /> diff --git a/x-pack/plugins/apm/public/components/app/service_inventory/service_list/order_service_items.test.ts b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/order_service_items.test.ts new file mode 100644 index 00000000000000..5877ee64239b6b --- /dev/null +++ b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/order_service_items.test.ts @@ -0,0 +1,230 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { ServiceHealthStatus } from '../../../../../common/service_health_status'; +import { ServiceInventoryFieldName } from '../../../../../common/service_inventory'; +import { orderServiceItems } from './order_service_items'; + +describe('orderServiceItems', () => { + describe('when sorting by health status', () => { + describe('desc', () => { + it('orders from critical to unknown', () => { + const sortedItems = orderServiceItems({ + primarySortField: ServiceInventoryFieldName.HealthStatus, + sortDirection: 'desc', + tiebreakerField: ServiceInventoryFieldName.Throughput, + items: [ + { + serviceName: 'critical-service', + healthStatus: ServiceHealthStatus.critical, + }, + { + serviceName: 'healthy-service', + healthStatus: ServiceHealthStatus.healthy, + }, + { + serviceName: 'warning-service', + healthStatus: ServiceHealthStatus.warning, + }, + { + serviceName: 'unknown-service', + healthStatus: ServiceHealthStatus.unknown, + }, + ], + }); + + expect(sortedItems.map((item) => item.serviceName)).toEqual([ + 'critical-service', + 'warning-service', + 'healthy-service', + 'unknown-service', + ]); + }); + + it('sorts by service name ascending as a tie-breaker', () => { + const sortedItems = orderServiceItems({ + primarySortField: ServiceInventoryFieldName.HealthStatus, + sortDirection: 'desc', + tiebreakerField: ServiceInventoryFieldName.ServiceName, + items: [ + { + serviceName: 'b-critical-service', + healthStatus: ServiceHealthStatus.critical, + }, + { + serviceName: 'a-critical-service', + healthStatus: ServiceHealthStatus.critical, + }, + { + serviceName: 'a-unknown-service', + healthStatus: ServiceHealthStatus.unknown, + }, + { + serviceName: 'b-unknown-service', + healthStatus: ServiceHealthStatus.unknown, + }, + ], + }); + + expect(sortedItems.map((item) => item.serviceName)).toEqual([ + 'a-critical-service', + 'b-critical-service', + 'a-unknown-service', + 'b-unknown-service', + ]); + }); + + it('sorts by metric descending as a tie-breaker', () => { + const sortedItems = orderServiceItems({ + primarySortField: ServiceInventoryFieldName.HealthStatus, + sortDirection: 'desc', + tiebreakerField: ServiceInventoryFieldName.Throughput, + items: [ + { + serviceName: 'low-throughput-service', + healthStatus: ServiceHealthStatus.unknown, + throughput: 1, + }, + { + serviceName: 'high-throughput-service', + healthStatus: ServiceHealthStatus.unknown, + throughput: 100, + }, + { + serviceName: 'med-throughput-service', + healthStatus: ServiceHealthStatus.unknown, + throughput: 10, + }, + { + serviceName: 'critical-service', + healthStatus: ServiceHealthStatus.critical, + throughput: 0, + }, + ], + }); + + expect(sortedItems.map((item) => item.serviceName)).toEqual([ + 'critical-service', + 'high-throughput-service', + 'med-throughput-service', + 'low-throughput-service', + ]); + }); + }); + + describe('asc', () => { + it('orders from unknown to critical', () => { + const sortedItems = orderServiceItems({ + primarySortField: ServiceInventoryFieldName.HealthStatus, + sortDirection: 'asc', + tiebreakerField: ServiceInventoryFieldName.Throughput, + items: [ + { + serviceName: 'critical-service', + healthStatus: ServiceHealthStatus.critical, + }, + { + serviceName: 'healthy-service', + healthStatus: ServiceHealthStatus.healthy, + }, + { + serviceName: 'warning-service', + healthStatus: ServiceHealthStatus.warning, + }, + { + serviceName: 'unknown-service', + healthStatus: ServiceHealthStatus.unknown, + }, + ], + }); + + expect(sortedItems.map((item) => item.serviceName)).toEqual([ + 'unknown-service', + 'healthy-service', + 'warning-service', + 'critical-service', + ]); + }); + }); + }); + + describe('when sorting by metric fields', () => { + it('sorts correctly', () => { + const sortedItems = orderServiceItems({ + primarySortField: ServiceInventoryFieldName.Throughput, + sortDirection: 'desc', + tiebreakerField: ServiceInventoryFieldName.Throughput, + items: [ + { + serviceName: 'low-throughput-service', + healthStatus: ServiceHealthStatus.unknown, + throughput: 1, + }, + { + serviceName: 'high-throughput-service', + healthStatus: ServiceHealthStatus.unknown, + throughput: 100, + }, + { + serviceName: 'med-throughput-service', + healthStatus: ServiceHealthStatus.unknown, + throughput: 10, + }, + { + serviceName: 'critical-service', + healthStatus: ServiceHealthStatus.critical, + throughput: 0, + }, + ], + }); + + expect(sortedItems.map((item) => item.serviceName)).toEqual([ + 'high-throughput-service', + 'med-throughput-service', + 'low-throughput-service', + 'critical-service', + ]); + }); + }); + + describe('when sorting by alphabetical fields', () => { + const sortedItems = orderServiceItems({ + primarySortField: ServiceInventoryFieldName.ServiceName, + sortDirection: 'asc', + tiebreakerField: ServiceInventoryFieldName.ServiceName, + items: [ + { + serviceName: 'd-service', + healthStatus: ServiceHealthStatus.unknown, + }, + { + serviceName: 'a-service', + healthStatus: ServiceHealthStatus.unknown, + }, + { + serviceName: 'b-service', + healthStatus: ServiceHealthStatus.unknown, + }, + { + serviceName: 'c-service', + healthStatus: ServiceHealthStatus.unknown, + }, + { + serviceName: '0-service', + healthStatus: ServiceHealthStatus.unknown, + }, + ], + }); + + expect(sortedItems.map((item) => item.serviceName)).toEqual([ + '0-service', + 'a-service', + 'b-service', + 'c-service', + 'd-service', + ]); + }); +}); diff --git a/x-pack/plugins/apm/public/components/app/service_inventory/service_list/order_service_items.ts b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/order_service_items.ts new file mode 100644 index 00000000000000..1e685d82154139 --- /dev/null +++ b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/order_service_items.ts @@ -0,0 +1,75 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { orderBy } from 'lodash'; +import { ServiceHealthStatus } from '../../../../../common/service_health_status'; +import { + ServiceListItem, + ServiceInventoryFieldName, +} from '../../../../../common/service_inventory'; + +type SortValueGetter = (item: ServiceListItem) => string | number; + +const SERVICE_HEALTH_STATUS_ORDER = [ + ServiceHealthStatus.unknown, + ServiceHealthStatus.healthy, + ServiceHealthStatus.warning, + ServiceHealthStatus.critical, +]; + +const sorts: Record = { + [ServiceInventoryFieldName.HealthStatus]: (item) => + item.healthStatus + ? SERVICE_HEALTH_STATUS_ORDER.indexOf(item.healthStatus) + : -1, + [ServiceInventoryFieldName.ServiceName]: (item) => + item.serviceName.toLowerCase(), + [ServiceInventoryFieldName.Environments]: (item) => + item.environments?.join(', ').toLowerCase() ?? '', + [ServiceInventoryFieldName.TransactionType]: (item) => + item.transactionType ?? '', + [ServiceInventoryFieldName.Latency]: (item) => item.latency ?? -1, + [ServiceInventoryFieldName.Throughput]: (item) => item.throughput ?? -1, + [ServiceInventoryFieldName.TransactionErrorRate]: (item) => + item.transactionErrorRate ?? -1, +}; + +function reverseSortDirection(sortDirection: 'asc' | 'desc') { + return sortDirection === 'asc' ? 'desc' : 'asc'; +} + +export function orderServiceItems({ + items, + primarySortField, + tiebreakerField, + sortDirection, +}: { + items: ServiceListItem[]; + primarySortField: ServiceInventoryFieldName; + tiebreakerField: ServiceInventoryFieldName; + sortDirection: 'asc' | 'desc'; +}): ServiceListItem[] { + // For healthStatus, sort items by healthStatus first, then by tie-breaker + + const sortFn = sorts[primarySortField as ServiceInventoryFieldName]; + + if (primarySortField === ServiceInventoryFieldName.HealthStatus) { + const tiebreakerSortDirection = + tiebreakerField === ServiceInventoryFieldName.ServiceName + ? reverseSortDirection(sortDirection) + : sortDirection; + + const tiebreakerSortFn = sorts[tiebreakerField]; + + return orderBy( + items, + [sortFn, tiebreakerSortFn], + [sortDirection, tiebreakerSortDirection] + ); + } + + return orderBy(items, sortFn, sortDirection); +} diff --git a/x-pack/plugins/apm/public/components/app/service_inventory/service_list/service_list.stories.tsx b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/service_list.stories.tsx index 628ef4617417cf..290f1e6b69b778 100644 --- a/x-pack/plugins/apm/public/components/app/service_inventory/service_list/service_list.stories.tsx +++ b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/service_list.stories.tsx @@ -11,6 +11,7 @@ import { MemoryRouter } from 'react-router-dom'; import { CoreStart } from '../../../../../../../../src/core/public'; import { createKibanaReactContext } from '../../../../../../../../src/plugins/kibana_react/public'; import { ServiceHealthStatus } from '../../../../../common/service_health_status'; +import { ServiceInventoryFieldName } from '../../../../../common/service_inventory'; import type { ApmPluginContextValue } from '../../../../context/apm_plugin/apm_plugin_context'; import { MockApmPluginContextWrapper } from '../../../../context/apm_plugin/mock_apm_plugin_context'; import { ServiceList } from './'; @@ -59,6 +60,10 @@ export const Example: Story = (args) => { Example.args = { isLoading: false, items, + displayHealthStatus: true, + initialSortField: ServiceInventoryFieldName.HealthStatus, + initialSortDirection: 'desc', + sortFn: (sortItems) => sortItems, }; export const EmptyState: Story = (args) => { @@ -67,6 +72,10 @@ export const EmptyState: Story = (args) => { EmptyState.args = { isLoading: false, items: [], + displayHealthStatus: true, + initialSortField: ServiceInventoryFieldName.HealthStatus, + initialSortDirection: 'desc', + sortFn: (sortItems) => sortItems, }; export const WithHealthWarnings: Story = (args) => { diff --git a/x-pack/plugins/apm/public/components/app/settings/schema/index.tsx b/x-pack/plugins/apm/public/components/app/settings/schema/index.tsx index 0ea03cb0614d40..41d99e4551cc08 100644 --- a/x-pack/plugins/apm/public/components/app/settings/schema/index.tsx +++ b/x-pack/plugins/apm/public/components/app/settings/schema/index.tsx @@ -56,6 +56,7 @@ export function Schema() { const cloudApmPackagePolicy = data.cloud_apm_package_policy; const hasCloudApmPackagePolicy = !!cloudApmPackagePolicy; const hasRequiredRole = !!data.has_required_role; + const latestApmPackageVersion = data.latest_apm_package_version; function updateLocalStorage(newStatus: FETCH_STATUS) { setApmDataStreamsMigrationStatus({ @@ -91,6 +92,7 @@ export function Schema() { hasCloudAgentPolicy={hasCloudAgentPolicy} hasRequiredRole={hasRequiredRole} cloudApmPackagePolicy={cloudApmPackagePolicy} + latestApmPackageVersion={latestApmPackageVersion} /> {isSwitchActive && ( - ); + return ; } diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/edit_apm_policy_form.tsx b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/edit_apm_policy_form.tsx index e8d3b5d6940aa5..be9c89601d4ab3 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/edit_apm_policy_form.tsx +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/edit_apm_policy_form.tsx @@ -12,7 +12,6 @@ import { PackagePolicyEditExtensionComponentProps, PackagePolicyVars, } from './typings'; -import { POLICY_ELASTIC_AGENT_ON_CLOUD } from '../../../../common/fleet'; interface Props { policy: PackagePolicy; @@ -32,11 +31,5 @@ export function EditAPMPolicyForm({ newPolicy, onChange }: Props) { }, }); } - return ( - - ); + return ; } diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/index.tsx b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/index.tsx index bce1d5936a3522..7f9ec6e069773c 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/index.tsx +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/index.tsx @@ -30,14 +30,9 @@ import { useKibana } from '../../../../../../../src/plugins/kibana_react/public' interface Props { updateAPMPolicy: (newVars: PackagePolicyVars, isValid: boolean) => void; vars?: PackagePolicyVars; - isCloudPolicy: boolean; } -export function APMPolicyForm({ - vars = {}, - isCloudPolicy, - updateAPMPolicy, -}: Props) { +export function APMPolicyForm({ vars = {}, updateAPMPolicy }: Props) { const tailSamplingPoliciesDocsLink = useKibana().services.docLinks?.links.apm.tailSamplingPolicies; const { @@ -48,17 +43,15 @@ export function APMPolicyForm({ tailSamplingSettings, } = useMemo(() => { return { - apmSettings: getApmSettings({ isCloudPolicy }), + apmSettings: getApmSettings(), rumSettings: getRUMSettings(), tlsSettings: getTLSSettings(), - agentAuthorizationSettings: getAgentAuthorizationSettings({ - isCloudPolicy, - }), + agentAuthorizationSettings: getAgentAuthorizationSettings(), tailSamplingSettings: getTailSamplingSettings( tailSamplingPoliciesDocsLink ), }; - }, [isCloudPolicy, tailSamplingPoliciesDocsLink]); + }, [tailSamplingPoliciesDocsLink]); function handleFormChange(key: string, value: any) { // Merge new key/value with the rest of fields diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/agent_authorization_settings.test.ts b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/agent_authorization_settings.test.ts index ed3cf83962df40..533c053ba42949 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/agent_authorization_settings.test.ts +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/agent_authorization_settings.test.ts @@ -6,39 +6,9 @@ */ import { getAgentAuthorizationSettings } from './agent_authorization_settings'; -import { SettingsRow } from '../typings'; import { isSettingsFormValid } from '../settings_form/utils'; describe('apm-fleet-apm-integration', () => { - describe('getAgentAuthorizationSettings', () => { - function findSetting(key: string, settings: SettingsRow[]) { - return settings.find( - (setting) => setting.type !== 'advanced_setting' && setting.key === key - ); - } - it('returns read only secret token when on cloud', () => { - const settings = getAgentAuthorizationSettings({ isCloudPolicy: true }); - const secretToken = findSetting('secret_token', settings); - expect(secretToken).toEqual({ - type: 'text', - key: 'secret_token', - labelAppend: 'Optional', - label: 'Secret token', - }); - }); - it('returns secret token when NOT on cloud', () => { - const settings = getAgentAuthorizationSettings({ isCloudPolicy: false }); - const secretToken = findSetting('secret_token', settings); - - expect(secretToken).toEqual({ - type: 'text', - key: 'secret_token', - labelAppend: 'Optional', - label: 'Secret token', - }); - }); - }); - describe('isAgentAuthorizationFormValid', () => { describe('validates integer fields', () => { [ @@ -47,9 +17,7 @@ describe('apm-fleet-apm-integration', () => { 'anonymous_rate_limit_event_limit', ].map((key) => { it(`returns false when ${key} is lower than 1`, () => { - const settings = getAgentAuthorizationSettings({ - isCloudPolicy: true, - }); + const settings = getAgentAuthorizationSettings(); expect( isSettingsFormValid(settings, { [key]: { value: 0, type: 'integer' }, diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/agent_authorization_settings.ts b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/agent_authorization_settings.ts index dff95bbf1702cf..c2a858b41e6153 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/agent_authorization_settings.ts +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/agent_authorization_settings.ts @@ -10,11 +10,7 @@ import { getIntegerRt } from '../../../../../common/agent_configuration/runtime_ import { OPTIONAL_LABEL } from '../settings_form/utils'; import { SettingsRow } from '../typings'; -export function getAgentAuthorizationSettings({ - isCloudPolicy, -}: { - isCloudPolicy: boolean; -}): SettingsRow[] { +export function getAgentAuthorizationSettings(): SettingsRow[] { return [ { type: 'boolean', diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/apm_settings.test.ts b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/apm_settings.test.ts index 2d2acbcd37c552..effef056d66012 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/apm_settings.test.ts +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/apm_settings.test.ts @@ -6,35 +6,14 @@ */ import { getApmSettings } from './apm_settings'; -import { SettingsRow, BasicSettingRow } from '../typings'; import { isSettingsFormValid } from '../settings_form/utils'; describe('apm_settings', () => { - describe('getApmSettings', () => { - function findSetting(key: string, settings: SettingsRow[]) { - return settings.find( - (setting) => setting.type !== 'advanced_setting' && setting.key === key - ) as BasicSettingRow; - } - ['host', 'url'].map((key) => { - it(`returns read only ${key} when on cloud`, () => { - const settings = getApmSettings({ isCloudPolicy: true }); - const setting = findSetting(key, settings); - expect(setting.readOnly).toBeTruthy(); - }); - it(`returns ${key} when NOT on cloud`, () => { - const settings = getApmSettings({ isCloudPolicy: false }); - const setting = findSetting(key, settings); - expect(setting.readOnly).toBeFalsy(); - }); - }); - }); - describe('isAPMFormValid', () => { describe('validates integer fields', () => { ['max_header_bytes', 'max_event_bytes'].map((key) => { it(`returns false when ${key} is lower than 1`, () => { - const settings = getApmSettings({ isCloudPolicy: true }); + const settings = getApmSettings(); expect( isSettingsFormValid(settings, { [key]: { value: 0, type: 'integer' }, @@ -50,7 +29,7 @@ describe('apm_settings', () => { }); ['max_connections'].map((key) => { it(`returns false when ${key} is lower than 0`, () => { - const settings = getApmSettings({ isCloudPolicy: true }); + const settings = getApmSettings(); expect( isSettingsFormValid(settings, { [key]: { value: -1, type: 'integer' }, @@ -63,7 +42,7 @@ describe('apm_settings', () => { describe('validates required fields', () => { ['host', 'url'].map((key) => { it(`return false when ${key} is not defined`, () => { - const settings = getApmSettings({ isCloudPolicy: true }); + const settings = getApmSettings(); expect(isSettingsFormValid(settings, {})).toBeFalsy(); }); }); @@ -73,7 +52,7 @@ describe('apm_settings', () => { ['idle_timeout', 'read_timeout', 'shutdown_timeout', 'write_timeout'].map( (key) => { it(`return false when ${key} lower then 1ms`, () => { - const settings = getApmSettings({ isCloudPolicy: true }); + const settings = getApmSettings(); expect( isSettingsFormValid(settings, { [key]: { value: '0ms', type: 'text' }, diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/apm_settings.ts b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/apm_settings.ts index 8adda7b5983f12..03032a6160502a 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/apm_settings.ts +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_definition/apm_settings.ts @@ -10,17 +10,12 @@ import { getIntegerRt } from '../../../../../common/agent_configuration/runtime_ import { OPTIONAL_LABEL, REQUIRED_LABEL } from '../settings_form/utils'; import { SettingsRow } from '../typings'; -export function getApmSettings({ - isCloudPolicy, -}: { - isCloudPolicy: boolean; -}): SettingsRow[] { +export function getApmSettings(): SettingsRow[] { return [ { type: 'text', key: 'host', labelAppend: REQUIRED_LABEL, - readOnly: isCloudPolicy, label: i18n.translate( 'xpack.apm.fleet_integration.settings.apm.hostLabel', { defaultMessage: 'Host' } @@ -43,7 +38,6 @@ export function getApmSettings({ type: 'text', key: 'url', labelAppend: REQUIRED_LABEL, - readOnly: isCloudPolicy, label: i18n.translate( 'xpack.apm.fleet_integration.settings.apm.urlLabel', { diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_form/form_row_setting.tsx b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_form/form_row_setting.tsx index 321440eeaeab70..56ba3c6d47eb50 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_form/form_row_setting.tsx +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_form/form_row_setting.tsx @@ -28,6 +28,7 @@ interface Props { row: SettingsRow; value?: any; onChange: FormRowOnChange; + isDisabled?: boolean; } const ENABLED_LABEL = i18n.translate( @@ -39,11 +40,12 @@ const DISABLED_LABEL = i18n.translate( { defaultMessage: 'Disabled' } ); -export function FormRowSetting({ row, value, onChange }: Props) { +export function FormRowSetting({ row, value, onChange, isDisabled }: Props) { switch (row.type) { case 'boolean': { return ( { @@ -56,9 +58,9 @@ export function FormRowSetting({ row, value, onChange }: Props) { case 'text': { return ( : undefined} + prepend={isDisabled ? : undefined} onChange={(e) => { onChange(row.key, e.target.value); }} @@ -68,6 +70,7 @@ export function FormRowSetting({ row, value, onChange }: Props) { case 'area': { return ( { onChange(row.key, e.target.value); @@ -79,6 +82,7 @@ export function FormRowSetting({ row, value, onChange }: Props) { case 'integer': { return ( { onChange(row.key, e.target.value); diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_form/index.tsx b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_form/index.tsx index 84b06e37b2ae26..a834c410987980 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_form/index.tsx +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/settings_form/index.tsx @@ -51,7 +51,7 @@ function FormRow({ if (!configEntry) { return null; } - const { value } = configEntry; + const { value, frozen } = configEntry; const { isValid, message } = validateSettingValue(row, value); return ( @@ -70,7 +70,12 @@ function FormRow({ } > - + {row.settings && diff --git a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/typings.ts b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/typings.ts index e7108e8910446f..c25031efad5fd2 100644 --- a/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/typings.ts +++ b/x-pack/plugins/apm/public/components/fleet_integration/apm_policy_form/typings.ts @@ -50,7 +50,6 @@ export interface BasicSettingRow { settings?: SettingsRow[]; validation?: SettingValidation; required?: boolean; - readOnly?: boolean; } export type SettingsRow = BasicSettingRow | AdvancedSettingRow; diff --git a/x-pack/plugins/apm/public/tutorial/config_agent/index.tsx b/x-pack/plugins/apm/public/tutorial/config_agent/index.tsx index 087ea8094ea793..68952193282fd9 100644 --- a/x-pack/plugins/apm/public/tutorial/config_agent/index.tsx +++ b/x-pack/plugins/apm/public/tutorial/config_agent/index.tsx @@ -9,10 +9,6 @@ import { i18n } from '@kbn/i18n'; import { HttpStart } from 'kibana/public'; import React, { useEffect, useMemo, useState } from 'react'; import styled from 'styled-components'; -import { - isPrereleaseVersion, - SUPPORTED_APM_PACKAGE_VERSION, -} from '../../../common/fleet'; import { APIReturnType } from '../../services/rest/create_call_apm_api'; import { getCommands } from './commands/get_commands'; import { getPolicyOptions, PolicyOption } from './get_policy_options'; @@ -72,9 +68,7 @@ function getFleetLink({ } : { label: GET_STARTED_WITH_FLEET_LABEL, - href: isPrereleaseVersion(kibanaVersion) - ? `${basePath}/app/integrations#/detail/apm/overview` - : `${basePath}/app/integrations#/detail/apm-${SUPPORTED_APM_PACKAGE_VERSION}/overview`, + href: `${basePath}/app/integrations#/detail/apm/overview`, }; } diff --git a/x-pack/plugins/apm/public/tutorial/tutorial_fleet_instructions/index.tsx b/x-pack/plugins/apm/public/tutorial/tutorial_fleet_instructions/index.tsx index 460f61d8ae1c5e..87a0d216648f91 100644 --- a/x-pack/plugins/apm/public/tutorial/tutorial_fleet_instructions/index.tsx +++ b/x-pack/plugins/apm/public/tutorial/tutorial_fleet_instructions/index.tsx @@ -19,10 +19,6 @@ import { i18n } from '@kbn/i18n'; import { HttpStart } from 'kibana/public'; import React, { useEffect, useState } from 'react'; import styled from 'styled-components'; -import { - isPrereleaseVersion, - SUPPORTED_APM_PACKAGE_VERSION, -} from '../../../common/fleet'; import { APIReturnType } from '../../services/rest/create_call_apm_api'; interface Props { @@ -78,9 +74,7 @@ function TutorialFleetInstructions({ const apmIntegrationHref = shouldLinkToMigration ? `${basePath}/app/apm/settings/schema` - : isPrereleaseVersion(kibanaVersion) - ? `${basePath}/app/integrations#/detail/apm/overview` - : `${basePath}/app/integrations/detail/apm-${SUPPORTED_APM_PACKAGE_VERSION}/overview`; + : `${basePath}/app/integrations#/detail/apm/overview`; if (isLoading) { return ( @@ -96,7 +90,7 @@ function TutorialFleetInstructions({ {i18n.translate( 'xpack.apm.tutorial.apmServer.fleet.manageApmIntegration.button', diff --git a/x-pack/plugins/apm/server/routes/fleet/create_cloud_apm_package_policy.ts b/x-pack/plugins/apm/server/routes/fleet/create_cloud_apm_package_policy.ts index 34a6de753d9109..797bce77facdb1 100644 --- a/x-pack/plugins/apm/server/routes/fleet/create_cloud_apm_package_policy.ts +++ b/x-pack/plugins/apm/server/routes/fleet/create_cloud_apm_package_policy.ts @@ -9,6 +9,7 @@ import { ElasticsearchClient, SavedObjectsClientContract, Logger, + KibanaRequest, } from 'kibana/server'; import { PackagePolicy } from '../../../../fleet/common'; import { @@ -30,7 +31,7 @@ export async function createCloudApmPackgePolicy({ esClient, logger, setup, - kibanaVersion, + request, }: { cloudPluginSetup: APMPluginSetupDependencies['cloud']; fleetPluginStart: NonNullable; @@ -38,7 +39,7 @@ export async function createCloudApmPackgePolicy({ esClient: ElasticsearchClient; logger: Logger; setup: Setup; - kibanaVersion: string; + request: KibanaRequest; }): Promise { const { attributes } = await savedObjectsClient.get( APM_SERVER_SCHEMA_SAVED_OBJECT_TYPE, @@ -52,7 +53,7 @@ export async function createCloudApmPackgePolicy({ apmServerSchema, cloudPluginSetup, fleetPluginStart, - kibanaVersion, + request, }); const mergedAPMPackagePolicy = await mergePackagePolicyWithApm({ setup, diff --git a/x-pack/plugins/apm/server/routes/fleet/get_apm_package_policy_definition.ts b/x-pack/plugins/apm/server/routes/fleet/get_apm_package_policy_definition.ts index 6d4af4e33ad5b1..85ac03697019c3 100644 --- a/x-pack/plugins/apm/server/routes/fleet/get_apm_package_policy_definition.ts +++ b/x-pack/plugins/apm/server/routes/fleet/get_apm_package_policy_definition.ts @@ -5,29 +5,35 @@ * 2.0. */ +import { KibanaRequest } from 'kibana/server'; +import { RegistryVarsEntry } from '../../../../fleet/common'; import { - isPrereleaseVersion, POLICY_ELASTIC_AGENT_ON_CLOUD, - SUPPORTED_APM_PACKAGE_VERSION, + INPUT_VAR_NAME_TO_SCHEMA_PATH, ELASTIC_CLOUD_APM_AGENT_POLICY_ID, } from '../../../common/fleet'; import { APMPluginSetupDependencies, APMPluginStartDependencies, } from '../../types'; -import { APM_PACKAGE_NAME } from './get_cloud_apm_package_policy'; +import { getLatestApmPackage } from './get_latest_apm_package'; +import { translateLegacySchemaPaths } from './translate_legacy_schema_paths'; -interface GetApmPackagePolicyDefinitionOptions { +export async function getApmPackagePolicyDefinition({ + apmServerSchema, + cloudPluginSetup, + fleetPluginStart, + request, +}: { apmServerSchema: Record; cloudPluginSetup: APMPluginSetupDependencies['cloud']; - fleetPluginStart: APMPluginStartDependencies['fleet']; - kibanaVersion: string; -} -export async function getApmPackagePolicyDefinition( - options: GetApmPackagePolicyDefinitionOptions -) { - const { apmServerSchema, cloudPluginSetup, fleetPluginStart, kibanaVersion } = - options; + fleetPluginStart: NonNullable; + request: KibanaRequest; +}) { + const latestApmPackage = await getLatestApmPackage({ + fleetPluginStart, + request, + }); return { id: ELASTIC_CLOUD_APM_AGENT_POLICY_ID, @@ -42,255 +48,45 @@ export async function getApmPackagePolicyDefinition( enabled: true, streams: [], vars: getApmPackageInputVars({ + policyTemplateInputVars: latestApmPackage.policyTemplateInputVars, + apmServerSchema: translateLegacySchemaPaths(apmServerSchema), cloudPluginSetup, - fleetPluginStart, - apmServerSchema: preprocessLegacyFields({ apmServerSchema }), - kibanaVersion, }), }, ], package: { - name: APM_PACKAGE_NAME, - version: await getApmPackageVersion(fleetPluginStart, kibanaVersion), - title: 'Elastic APM', + name: latestApmPackage.package.name, + version: latestApmPackage.package.version, + title: latestApmPackage.package.title, }, }; } -async function getApmPackageVersion( - fleetPluginStart: APMPluginStartDependencies['fleet'], - kibanaVersion: string -) { - if (fleetPluginStart && isPrereleaseVersion(kibanaVersion)) { - try { - const latestApmPackage = - await fleetPluginStart.packageService.asInternalUser.fetchFindLatestPackage( - 'apm' - ); - return latestApmPackage.version; - } catch (error) { - return SUPPORTED_APM_PACKAGE_VERSION; - } - } - return SUPPORTED_APM_PACKAGE_VERSION; -} - -export function preprocessLegacyFields({ +function getApmPackageInputVars({ + policyTemplateInputVars, apmServerSchema, + cloudPluginSetup, }: { + policyTemplateInputVars: RegistryVarsEntry[]; apmServerSchema: Record; -}) { - const copyOfApmServerSchema = { ...apmServerSchema }; - [ - { - key: 'apm-server.auth.anonymous.rate_limit.event_limit', - legacyKey: 'apm-server.rum.event_rate.limit', - }, - { - key: 'apm-server.auth.anonymous.rate_limit.ip_limit', - legacyKey: 'apm-server.rum.event_rate.lru_size', - }, - { - key: 'apm-server.auth.anonymous.allow_service', - legacyKey: 'apm-server.rum.allow_service_names', - }, - { - key: 'apm-server.auth.secret_token', - legacyKey: 'apm-server.secret_token', - }, - { - key: 'apm-server.auth.api_key.enabled', - legacyKey: 'apm-server.api_key.enabled', - }, - ].forEach(({ key, legacyKey }) => { - if (!copyOfApmServerSchema[key]) { - copyOfApmServerSchema[key] = copyOfApmServerSchema[legacyKey]; - delete copyOfApmServerSchema[legacyKey]; - } - }); - return copyOfApmServerSchema; -} - -function getApmPackageInputVars(options: GetApmPackagePolicyDefinitionOptions) { - const { apmServerSchema } = options; - const apmServerConfigs = Object.entries(apmConfigMapping).map( - ([key, { name, type, getValue }]) => ({ key, name, type, getValue }) - ); + cloudPluginSetup: APMPluginSetupDependencies['cloud']; +}): Record { + const overrideValues: Record = { + url: cloudPluginSetup?.apm?.url, // overrides 'apm-server.url' to be the cloud APM host + }; - const inputVars: Record = - apmServerConfigs.reduce((acc, { key, name, type, getValue }) => { - const value = (getValue ? getValue(options) : apmServerSchema[key]) ?? ''; // defaults to an empty string to be edited in Fleet UI - return { - ...acc, - [name]: { type, value }, - }; - }, {}); - return inputVars; + return policyTemplateInputVars.reduce((acc, registryVarsEntry) => { + const { name, type, default: defaultValue } = registryVarsEntry; + return { + ...acc, + [name]: { + type, + value: + overrideValues[name] ?? + apmServerSchema[INPUT_VAR_NAME_TO_SCHEMA_PATH[name]] ?? + defaultValue ?? + '', + }, + }; + }, {}); } - -export const apmConfigMapping: Record< - string, - { - name: string; - type: string; - getValue?: (options: GetApmPackagePolicyDefinitionOptions) => any; - } -> = { - 'apm-server.host': { - name: 'host', - type: 'text', - }, - 'apm-server.url': { - name: 'url', - type: 'text', - getValue: ({ cloudPluginSetup }) => cloudPluginSetup?.apm?.url, - }, - 'apm-server.rum.enabled': { - name: 'enable_rum', - type: 'bool', - }, - 'apm-server.default_service_environment': { - name: 'default_service_environment', - type: 'text', - }, - 'apm-server.rum.allow_origins': { - name: 'rum_allow_origins', - type: 'text', - }, - 'apm-server.rum.allow_headers': { - name: 'rum_allow_headers', - type: 'text', - }, - 'apm-server.rum.event_rate.limit': { - name: 'rum_event_rate_limit', - type: 'integer', - }, - 'apm-server.rum.allow_service_names': { - name: 'rum_allow_service_names', - type: 'text', - }, - 'apm-server.rum.event_rate.lru_size': { - name: 'rum_event_rate_lru_size', - type: 'integer', - }, - 'apm-server.rum.response_headers': { - name: 'rum_response_headers', - type: 'yaml', - }, - 'apm-server.rum.library_pattern': { - name: 'rum_library_pattern', - type: 'text', - }, - 'apm-server.rum.exclude_from_grouping': { - name: 'rum_exclude_from_grouping', - type: 'text', - }, - 'apm-server.max_event_size': { - name: 'max_event_bytes', - type: 'integer', - }, - 'apm-server.capture_personal_data': { - name: 'capture_personal_data', - type: 'bool', - }, - 'apm-server.max_header_size': { - name: 'max_header_bytes', - type: 'integer', - }, - 'apm-server.idle_timeout': { - name: 'idle_timeout', - type: 'text', - }, - 'apm-server.read_timeout': { - name: 'read_timeout', - type: 'text', - }, - 'apm-server.shutdown_timeout': { - name: 'shutdown_timeout', - type: 'text', - }, - 'apm-server.write_timeout': { - name: 'write_timeout', - type: 'text', - }, - 'apm-server.max_connections': { - name: 'max_connections', - type: 'integer', - }, - 'apm-server.response_headers': { - name: 'response_headers', - type: 'yaml', - }, - 'apm-server.expvar.enabled': { - name: 'expvar_enabled', - type: 'bool', - }, - 'apm-server.ssl.enabled': { - name: 'tls_enabled', - type: 'bool', - }, - 'apm-server.ssl.certificate': { - name: 'tls_certificate', - type: 'text', - }, - 'apm-server.ssl.key': { - name: 'tls_key', - type: 'text', - }, - 'apm-server.ssl.supported_protocols': { - name: 'tls_supported_protocols', - type: 'text', - }, - 'apm-server.ssl.cipher_suites': { - name: 'tls_cipher_suites', - type: 'text', - }, - 'apm-server.ssl.curve_types': { - name: 'tls_curve_types', - type: 'text', - }, - 'apm-server.auth.secret_token': { - name: 'secret_token', - type: 'text', - }, - 'apm-server.auth.api_key.enabled': { - name: 'api_key_enabled', - type: 'bool', - }, - 'apm-server.auth.api_key.limit': { - name: 'api_key_limit', - type: 'bool', - }, - 'apm-server.auth.anonymous.enabled': { - name: 'anonymous_enabled', - type: 'bool', - }, - 'apm-server.auth.anonymous.allow_agent': { - name: 'anonymous_allow_agent', - type: 'text', - }, - 'apm-server.auth.anonymous.allow_service': { - name: 'anonymous_allow_service', - type: 'text', - }, - 'apm-server.auth.anonymous.rate_limit.ip_limit': { - name: 'anonymous_rate_limit_ip_limit', - type: 'integer', - }, - 'apm-server.auth.anonymous.rate_limit.event_limit': { - name: 'anonymous_rate_limit_event_limit', - type: 'integer', - }, - 'apm-server.sampling.tail.enabled': { - name: 'tail_sampling_enabled', - type: 'bool', - }, - 'apm-server.sampling.tail.interval': { - name: 'tail_sampling_interval', - type: 'text', - }, - 'apm-server.sampling.tail.policies': { - name: 'tail_sampling_policies', - type: 'yaml', - }, -}; diff --git a/x-pack/plugins/apm/server/routes/fleet/get_latest_apm_package.ts b/x-pack/plugins/apm/server/routes/fleet/get_latest_apm_package.ts new file mode 100644 index 00000000000000..ba5b9f4b919e99 --- /dev/null +++ b/x-pack/plugins/apm/server/routes/fleet/get_latest_apm_package.ts @@ -0,0 +1,28 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { KibanaRequest } from 'kibana/server'; +import { APMPluginStartDependencies } from '../../types'; +import { APM_PACKAGE_NAME } from './get_cloud_apm_package_policy'; + +export async function getLatestApmPackage({ + fleetPluginStart, + request, +}: { + fleetPluginStart: NonNullable; + request: KibanaRequest; +}) { + const packageClient = fleetPluginStart.packageService.asScoped(request); + const { name, version } = await packageClient.fetchFindLatestPackage( + APM_PACKAGE_NAME + ); + const registryPackage = await packageClient.getRegistryPackage(name, version); + const { title, policy_templates: policyTemplates } = + registryPackage.packageInfo; + const policyTemplateInputVars = policyTemplates?.[0].inputs?.[0].vars ?? []; + return { package: { name, version, title }, policyTemplateInputVars }; +} diff --git a/x-pack/plugins/apm/server/routes/fleet/get_unsupported_apm_server_schema.ts b/x-pack/plugins/apm/server/routes/fleet/get_unsupported_apm_server_schema.ts index 2ced15245b5933..fa2b4c585cb9d0 100644 --- a/x-pack/plugins/apm/server/routes/fleet/get_unsupported_apm_server_schema.ts +++ b/x-pack/plugins/apm/server/routes/fleet/get_unsupported_apm_server_schema.ts @@ -6,14 +6,12 @@ */ import { SavedObjectsClientContract } from 'kibana/server'; +import { INPUT_VAR_NAME_TO_SCHEMA_PATH } from '../../../common/fleet'; import { APM_SERVER_SCHEMA_SAVED_OBJECT_TYPE, APM_SERVER_SCHEMA_SAVED_OBJECT_ID, } from '../../../common/apm_saved_object_constants'; -import { - apmConfigMapping, - preprocessLegacyFields, -} from './get_apm_package_policy_definition'; +import { translateLegacySchemaPaths } from './translate_legacy_schema_paths'; export async function getUnsupportedApmServerSchema({ savedObjectsClient, @@ -27,10 +25,9 @@ export async function getUnsupportedApmServerSchema({ const apmServerSchema: Record = JSON.parse( (attributes as { schemaJson: string }).schemaJson ); - const preprocessedApmServerSchema = preprocessLegacyFields({ - apmServerSchema, - }); - return Object.entries(preprocessedApmServerSchema) - .filter(([name]) => !(name in apmConfigMapping)) + const translatedApmServerSchema = translateLegacySchemaPaths(apmServerSchema); + const supportedSchemaPaths = Object.values(INPUT_VAR_NAME_TO_SCHEMA_PATH); + return Object.entries(translatedApmServerSchema) + .filter(([name]) => !supportedSchemaPaths.includes(name)) .map(([key, value]) => ({ key, value })); } diff --git a/x-pack/plugins/apm/server/routes/fleet/route.ts b/x-pack/plugins/apm/server/routes/fleet/route.ts index 97949dfc7d0c3f..2b6412647641cf 100644 --- a/x-pack/plugins/apm/server/routes/fleet/route.ts +++ b/x-pack/plugins/apm/server/routes/fleet/route.ts @@ -25,6 +25,7 @@ import { isSuperuser } from './is_superuser'; import { getInternalSavedObjectsClient } from '../../lib/helpers/get_internal_saved_objects_client'; import { setupRequest } from '../../lib/helpers/setup_request'; import { createApmServerRoute } from '../apm_routes/create_apm_server_route'; +import { getLatestApmPackage } from './get_latest_apm_package'; const hasFleetDataRoute = createApmServerRoute({ endpoint: 'GET /internal/apm/fleet/has_apm_policies', @@ -177,6 +178,7 @@ const getMigrationCheckRoute = createApmServerRoute({ | import('./../../../../fleet/common/index').PackagePolicy | undefined; has_apm_integrations: boolean; + latest_apm_package_version: string; }> => { const { core, plugins, context, config, request } = resources; const cloudApmMigrationEnabled = config.agent.migrations.enabled; @@ -200,6 +202,10 @@ const getMigrationCheckRoute = createApmServerRoute({ core, fleetPluginStart, }); + const latestApmPackage = await getLatestApmPackage({ + fleetPluginStart, + request, + }); return { has_cloud_agent_policy: !!cloudAgentPolicy, has_cloud_apm_package_policy: !!apmPackagePolicy, @@ -207,6 +213,7 @@ const getMigrationCheckRoute = createApmServerRoute({ has_required_role: hasRequiredRole, cloud_apm_package_policy: apmPackagePolicy, has_apm_integrations: packagePolicies.total > 0, + latest_apm_package_version: latestApmPackage.package.version, }; }, }); @@ -219,8 +226,7 @@ const createCloudApmPackagePolicyRoute = createApmServerRoute({ ): Promise<{ cloudApmPackagePolicy: import('./../../../../fleet/common/index').PackagePolicy; }> => { - const { plugins, context, config, request, logger, kibanaVersion } = - resources; + const { plugins, context, config, request, logger } = resources; const cloudApmMigrationEnabled = config.agent.migrations.enabled; if (!plugins.fleet || !plugins.security) { throw Boom.internal(FLEET_SECURITY_REQUIRED_MESSAGE); @@ -247,7 +253,7 @@ const createCloudApmPackagePolicyRoute = createApmServerRoute({ esClient, logger, setup, - kibanaVersion, + request, }); return { cloudApmPackagePolicy }; diff --git a/x-pack/plugins/apm/server/routes/fleet/get_apm_package_policy_definition.test.ts b/x-pack/plugins/apm/server/routes/fleet/translate_legacy_schema_paths.test.ts similarity index 91% rename from x-pack/plugins/apm/server/routes/fleet/get_apm_package_policy_definition.test.ts rename to x-pack/plugins/apm/server/routes/fleet/translate_legacy_schema_paths.test.ts index 805099d87e1c6f..09cab871d3a5b4 100644 --- a/x-pack/plugins/apm/server/routes/fleet/get_apm_package_policy_definition.test.ts +++ b/x-pack/plugins/apm/server/routes/fleet/translate_legacy_schema_paths.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { preprocessLegacyFields } from './get_apm_package_policy_definition'; +import { translateLegacySchemaPaths } from './translate_legacy_schema_paths'; const apmServerSchema = { 'apm-server.host': '0.0.0.0:8200', @@ -24,7 +24,7 @@ const apmServerSchema = { describe('get_apm_package_policy_definition', () => { describe('preprocessLegacyFields', () => { it('should replace legacy fields with supported fields', () => { - const result = preprocessLegacyFields({ apmServerSchema }); + const result = translateLegacySchemaPaths(apmServerSchema); expect(result).toMatchInlineSnapshot(` Object { "apm-server.auth.anonymous.allow_service": "opbeans-test", diff --git a/x-pack/plugins/apm/server/routes/fleet/translate_legacy_schema_paths.ts b/x-pack/plugins/apm/server/routes/fleet/translate_legacy_schema_paths.ts new file mode 100644 index 00000000000000..ca8de7d6e7a626 --- /dev/null +++ b/x-pack/plugins/apm/server/routes/fleet/translate_legacy_schema_paths.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { LEGACY_TO_CURRENT_SCHEMA_PATHS } from '../../../common/fleet'; + +export function translateLegacySchemaPaths( + apmServerSchema: Record +) { + return Object.keys(apmServerSchema).reduce((acc, apmServerSchemaKey) => { + const currentSchemaPath = + LEGACY_TO_CURRENT_SCHEMA_PATHS[apmServerSchemaKey] || apmServerSchemaKey; + return { + ...acc, + [currentSchemaPath]: apmServerSchema[apmServerSchemaKey], + }; + }, {}); +} diff --git a/x-pack/plugins/cases/docs/README.md b/x-pack/plugins/cases/docs/README.md deleted file mode 100644 index 03f089280bc57c..00000000000000 --- a/x-pack/plugins/cases/docs/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# Cases Client API Docs - -This directory contains generated docs using `typedoc` for the cases client API that can be called from other server -plugins. This README will describe how to generate a new version of these markdown docs in the event that new methods -or parameters are added. - -## TypeDoc Info - -See more info at: -markdown plugin: -missing exports plugin: - -## Install dependencies - -Ensure that your global typescript version is the same as kibana's - -You can run `npx tsc --version` to find the global compiler version and then check the version under `node_modules/typescript/lib`. - -```bash -yarn global add typedoc typedoc-plugin-markdown typedoc-plugin-missing-exports -``` - -## Generate the docs - -```bash -cd x-pack/plugins/cases/docs -npx typedoc --options cases_client_typedoc.json -``` - -After running the above commands the files in the `server` directory will be updated to match the new tsdocs. -If additional markdown directory should be created we can create a new typedoc configuration file and adjust the `out` -directory accordingly. - -## Troubleshooting - -If you run into tsc errors that seem unrelated to the cases plugin try executing these commands before running `typedoc` - -```bash -cd -npx yarn kbn bootstrap -node scripts/build_ts_refs.js --clean --no-cache -``` diff --git a/x-pack/plugins/cases/docs/cases_client/.nojekyll b/x-pack/plugins/cases/docs/cases_client/.nojekyll deleted file mode 100644 index e2ac6616addc2d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/x-pack/plugins/cases/docs/cases_client/README.md b/x-pack/plugins/cases/docs/cases_client/README.md deleted file mode 100644 index c3fa291458cca9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/README.md +++ /dev/null @@ -1,18 +0,0 @@ -Cases Client API Interface - -# Cases Client API Interface - -## Table of contents - -### Modules - -- [attachments/client](modules/attachments_client.md) -- [cases/client](modules/cases_client.md) -- [cases/get](modules/cases_get.md) -- [cases/push](modules/cases_push.md) -- [client](modules/client.md) -- [configure/client](modules/configure_client.md) -- [metrics/client](modules/metrics_client.md) -- [stats/client](modules/stats_client.md) -- [typedoc\_interfaces](modules/typedoc_interfaces.md) -- [user\_actions/client](modules/user_actions_client.md) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionExecutor.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionExecutor.md deleted file mode 100644 index 720db77a77e7e6..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionExecutor.md +++ /dev/null @@ -1,153 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionExecutor - -# Class: ActionExecutor - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionExecutor - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.ActionExecutor.md#constructor) - -### Properties - -- [actionExecutorContext](client._internal_namespace.ActionExecutor.md#actionexecutorcontext) -- [actionInfo](client._internal_namespace.ActionExecutor.md#actioninfo) -- [isESOCanEncrypt](client._internal_namespace.ActionExecutor.md#isesocanencrypt) -- [isInitialized](client._internal_namespace.ActionExecutor.md#isinitialized) - -### Methods - -- [execute](client._internal_namespace.ActionExecutor.md#execute) -- [initialize](client._internal_namespace.ActionExecutor.md#initialize) -- [logCancellation](client._internal_namespace.ActionExecutor.md#logcancellation) - -## Constructors - -### constructor - -• **new ActionExecutor**(`__namedParameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.isESOCanEncrypt` | `boolean` | - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:40 - -## Properties - -### actionExecutorContext - -• `Private` `Optional` **actionExecutorContext**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:37 - -___ - -### actionInfo - -• `Private` **actionInfo**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:39 - -___ - -### isESOCanEncrypt - -• `Private` `Readonly` **isESOCanEncrypt**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:38 - -___ - -### isInitialized - -• `Private` **isInitialized**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:36 - -## Methods - -### execute - -▸ **execute**(`__namedParameters`): `Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions.md)<`unknown`\> | - -#### Returns - -`Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`unknown`\>\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:44 - -___ - -### initialize - -▸ **initialize**(`actionExecutorContext`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionExecutorContext` | [`ActionExecutorContext`](../interfaces/client._internal_namespace.ActionExecutorContext.md) | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:43 - -___ - -### logCancellation - -▸ **logCancellation**<`Source`\>(`__namedParameters`): `Promise`<`void`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Source` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.actionId` | `string` | -| `__namedParameters.executionId?` | `string` | -| `__namedParameters.relatedSavedObjects` | `Readonly`<{ `namespace?`: `string` ; `typeId?`: `string` } & { `id`: `string` ; `type`: `string` }\>[] | -| `__namedParameters.request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | -| `__namedParameters.source?` | [`ActionExecutionSource`](../interfaces/client._internal_namespace.ActionExecutionSource.md)<`Source`\> | -| `__namedParameters.taskInfo?` | [`TaskInfo`](../interfaces/client._internal_namespace.TaskInfo.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionTypeRegistry.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionTypeRegistry.md deleted file mode 100644 index b801bdf26a158b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionTypeRegistry.md +++ /dev/null @@ -1,288 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionTypeRegistry - -# Class: ActionTypeRegistry - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionTypeRegistry - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.ActionTypeRegistry.md#constructor) - -### Properties - -- [actionTypes](client._internal_namespace.ActionTypeRegistry.md#actiontypes) -- [actionsConfigUtils](client._internal_namespace.ActionTypeRegistry.md#actionsconfigutils) -- [licenseState](client._internal_namespace.ActionTypeRegistry.md#licensestate) -- [licensing](client._internal_namespace.ActionTypeRegistry.md#licensing) -- [preconfiguredActions](client._internal_namespace.ActionTypeRegistry.md#preconfiguredactions) -- [taskManager](client._internal_namespace.ActionTypeRegistry.md#taskmanager) -- [taskRunnerFactory](client._internal_namespace.ActionTypeRegistry.md#taskrunnerfactory) - -### Methods - -- [ensureActionTypeEnabled](client._internal_namespace.ActionTypeRegistry.md#ensureactiontypeenabled) -- [get](client._internal_namespace.ActionTypeRegistry.md#get) -- [has](client._internal_namespace.ActionTypeRegistry.md#has) -- [isActionExecutable](client._internal_namespace.ActionTypeRegistry.md#isactionexecutable) -- [isActionTypeEnabled](client._internal_namespace.ActionTypeRegistry.md#isactiontypeenabled) -- [list](client._internal_namespace.ActionTypeRegistry.md#list) -- [register](client._internal_namespace.ActionTypeRegistry.md#register) - -## Constructors - -### constructor - -• **new ActionTypeRegistry**(`constructorParams`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorParams` | [`ActionTypeRegistryOpts`](../interfaces/client._internal_namespace.ActionTypeRegistryOpts.md) | - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:23 - -## Properties - -### actionTypes - -• `Private` `Readonly` **actionTypes**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:17 - -___ - -### actionsConfigUtils - -• `Private` `Readonly` **actionsConfigUtils**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:19 - -___ - -### licenseState - -• `Private` `Readonly` **licenseState**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:20 - -___ - -### licensing - -• `Private` `Readonly` **licensing**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:22 - -___ - -### preconfiguredActions - -• `Private` `Readonly` **preconfiguredActions**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:21 - -___ - -### taskManager - -• `Private` `Readonly` **taskManager**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:16 - -___ - -### taskRunnerFactory - -• `Private` `Readonly` **taskRunnerFactory**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:18 - -## Methods - -### ensureActionTypeEnabled - -▸ **ensureActionTypeEnabled**(`id`): `void` - -Throws error if action type is not enabled. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:31 - -___ - -### get - -▸ **get**<`Config`, `Secrets`, `Params`, `ExecutorResultData`\>(`id`): [`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<`Config`, `Secrets`, `Params`, `ExecutorResultData`\> - -Returns an action type, throws if not registered - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | -| `Secrets` | extends [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) = [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) | -| `Params` | extends [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) = [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) | -| `ExecutorResultData` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -[`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<`Config`, `Secrets`, `Params`, `ExecutorResultData`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:51 - -___ - -### has - -▸ **has**(`id`): `boolean` - -Returns if the action type registry has the given action type registered - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:27 - -___ - -### isActionExecutable - -▸ **isActionExecutable**(`actionId`, `actionTypeId`, `options?`): `boolean` - -Returns true if action type is enabled or it is a preconfigured action type. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionId` | `string` | -| `actionTypeId` | `string` | -| `options?` | `Object` | -| `options.notifyUsage` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:41 - -___ - -### isActionTypeEnabled - -▸ **isActionTypeEnabled**(`id`, `options?`): `boolean` - -Returns true if action type is enabled in the config and a valid license is used. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `options?` | `Object` | -| `options.notifyUsage` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:35 - -___ - -### list - -▸ **list**(): [`ActionType`](../interfaces/client._internal_namespace.ActionType.md)[] - -Returns a list of registered action types [{ id, name, enabled }] - -#### Returns - -[`ActionType`](../interfaces/client._internal_namespace.ActionType.md)[] - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:55 - -___ - -### register - -▸ **register**<`Config`, `Secrets`, `Params`, `ExecutorResultData`\>(`actionType`): `void` - -Registers an action type to the action type registry - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | -| `Secrets` | extends [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) = [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) | -| `Params` | extends [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) = [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) | -| `ExecutorResultData` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionType` | [`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<`Config`, `Secrets`, `Params`, `ExecutorResultData`\> | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:47 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Actions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Actions.md deleted file mode 100644 index c05dbe40c3657b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Actions.md +++ /dev/null @@ -1,144 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Actions - -# Class: Actions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Actions - -Actions are used to create the "actions" that are associated with Elasticsearch's -application privileges, and are used to perform the authorization checks implemented -by the various `checkPrivilegesWithRequest` derivatives. - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.Actions.md#constructor) - -### Properties - -- [alerting](client._internal_namespace.Actions.md#alerting) -- [api](client._internal_namespace.Actions.md#api) -- [app](client._internal_namespace.Actions.md#app) -- [cases](client._internal_namespace.Actions.md#cases) -- [login](client._internal_namespace.Actions.md#login) -- [savedObject](client._internal_namespace.Actions.md#savedobject) -- [space](client._internal_namespace.Actions.md#space) -- [ui](client._internal_namespace.Actions.md#ui) -- [version](client._internal_namespace.Actions.md#version) -- [versionNumber](client._internal_namespace.Actions.md#versionnumber) - -## Constructors - -### constructor - -• **new Actions**(`versionNumber`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionNumber` | `string` | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:23 - -## Properties - -### alerting - -• `Readonly` **alerting**: [`AlertingActions`](client._internal_namespace.AlertingActions.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:19 - -___ - -### api - -• `Readonly` **api**: [`ApiActions`](client._internal_namespace.ApiActions.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:14 - -___ - -### app - -• `Readonly` **app**: [`AppActions`](client._internal_namespace.AppActions.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:15 - -___ - -### cases - -• `Readonly` **cases**: [`CasesActions`](client._internal_namespace.CasesActions.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:16 - -___ - -### login - -• `Readonly` **login**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:17 - -___ - -### savedObject - -• `Readonly` **savedObject**: [`SavedObjectActions`](client._internal_namespace.SavedObjectActions.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:18 - -___ - -### space - -• `Readonly` **space**: [`SpaceActions`](client._internal_namespace.SpaceActions.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:20 - -___ - -### ui - -• `Readonly` **ui**: [`UIActions`](client._internal_namespace.UIActions.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:21 - -___ - -### version - -• `Readonly` **version**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:22 - -___ - -### versionNumber - -• `Private` `Readonly` **versionNumber**: `any` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:13 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsAuthorization.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsAuthorization.md deleted file mode 100644 index eb1403431969da..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsAuthorization.md +++ /dev/null @@ -1,99 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionsAuthorization - -# Class: ActionsAuthorization - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionsAuthorization - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.ActionsAuthorization.md#constructor) - -### Properties - -- [authorization](client._internal_namespace.ActionsAuthorization.md#authorization) -- [authorizationMode](client._internal_namespace.ActionsAuthorization.md#authorizationmode) -- [isOperationExemptDueToLegacyRbac](client._internal_namespace.ActionsAuthorization.md#isoperationexemptduetolegacyrbac) -- [request](client._internal_namespace.ActionsAuthorization.md#request) - -### Methods - -- [ensureAuthorized](client._internal_namespace.ActionsAuthorization.md#ensureauthorized) - -## Constructors - -### constructor - -• **new ActionsAuthorization**(`__namedParameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ConstructorOptions`](../interfaces/client._internal_namespace.ConstructorOptions-1.md) | - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:14 - -## Properties - -### authorization - -• `Private` `Optional` `Readonly` **authorization**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:12 - -___ - -### authorizationMode - -• `Private` `Readonly` **authorizationMode**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:13 - -___ - -### isOperationExemptDueToLegacyRbac - -• `Private` **isOperationExemptDueToLegacyRbac**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:16 - -___ - -### request - -• `Private` `Readonly` **request**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:11 - -## Methods - -### ensureAuthorized - -▸ **ensureAuthorized**(`operation`, `actionTypeId?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation` | `string` | -| `actionTypeId?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:15 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsClient.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsClient.md deleted file mode 100644 index a566950c5fa21e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsClient.md +++ /dev/null @@ -1,432 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionsClient - -# Class: ActionsClient - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionsClient - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.ActionsClient.md#constructor) - -### Properties - -- [actionExecutor](client._internal_namespace.ActionsClient.md#actionexecutor) -- [actionTypeRegistry](client._internal_namespace.ActionsClient.md#actiontyperegistry) -- [auditLogger](client._internal_namespace.ActionsClient.md#auditlogger) -- [authorization](client._internal_namespace.ActionsClient.md#authorization) -- [connectorTokenClient](client._internal_namespace.ActionsClient.md#connectortokenclient) -- [defaultKibanaIndex](client._internal_namespace.ActionsClient.md#defaultkibanaindex) -- [ephemeralExecutionEnqueuer](client._internal_namespace.ActionsClient.md#ephemeralexecutionenqueuer) -- [executionEnqueuer](client._internal_namespace.ActionsClient.md#executionenqueuer) -- [preconfiguredActions](client._internal_namespace.ActionsClient.md#preconfiguredactions) -- [request](client._internal_namespace.ActionsClient.md#request) -- [scopedClusterClient](client._internal_namespace.ActionsClient.md#scopedclusterclient) -- [unsecuredSavedObjectsClient](client._internal_namespace.ActionsClient.md#unsecuredsavedobjectsclient) -- [usageCounter](client._internal_namespace.ActionsClient.md#usagecounter) - -### Methods - -- [create](client._internal_namespace.ActionsClient.md#create) -- [delete](client._internal_namespace.ActionsClient.md#delete) -- [enqueueExecution](client._internal_namespace.ActionsClient.md#enqueueexecution) -- [ephemeralEnqueuedExecution](client._internal_namespace.ActionsClient.md#ephemeralenqueuedexecution) -- [execute](client._internal_namespace.ActionsClient.md#execute) -- [get](client._internal_namespace.ActionsClient.md#get) -- [getAll](client._internal_namespace.ActionsClient.md#getall) -- [getBulk](client._internal_namespace.ActionsClient.md#getbulk) -- [isActionTypeEnabled](client._internal_namespace.ActionsClient.md#isactiontypeenabled) -- [isPreconfigured](client._internal_namespace.ActionsClient.md#ispreconfigured) -- [listTypes](client._internal_namespace.ActionsClient.md#listtypes) -- [update](client._internal_namespace.ActionsClient.md#update) - -## Constructors - -### constructor - -• **new ActionsClient**(`__namedParameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ConstructorOptions`](../interfaces/client._internal_namespace.ConstructorOptions.md) | - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:57 - -## Properties - -### actionExecutor - -• `Private` `Readonly` **actionExecutor**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:49 - -___ - -### actionTypeRegistry - -• `Private` `Readonly` **actionTypeRegistry**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:47 - -___ - -### auditLogger - -• `Private` `Optional` `Readonly` **auditLogger**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:54 - -___ - -### authorization - -• `Private` `Readonly` **authorization**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:51 - -___ - -### connectorTokenClient - -• `Private` `Readonly` **connectorTokenClient**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:56 - -___ - -### defaultKibanaIndex - -• `Private` `Readonly` **defaultKibanaIndex**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:44 - -___ - -### ephemeralExecutionEnqueuer - -• `Private` `Readonly` **ephemeralExecutionEnqueuer**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:53 - -___ - -### executionEnqueuer - -• `Private` `Readonly` **executionEnqueuer**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:52 - -___ - -### preconfiguredActions - -• `Private` `Readonly` **preconfiguredActions**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:48 - -___ - -### request - -• `Private` `Readonly` **request**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:50 - -___ - -### scopedClusterClient - -• `Private` `Readonly` **scopedClusterClient**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:45 - -___ - -### unsecuredSavedObjectsClient - -• `Private` `Readonly` **unsecuredSavedObjectsClient**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:46 - -___ - -### usageCounter - -• `Private` `Optional` `Readonly` **usageCounter**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:55 - -## Methods - -### create - -▸ **create**(`__namedParameters`): `Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> - -Create an action - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateOptions`](../interfaces/client._internal_namespace.CreateOptions.md) | - -#### Returns - -`Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:61 - -___ - -### delete - -▸ **delete**(`__namedParameters`): `Promise`<{}\> - -Delete action - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.id` | `string` | - -#### Returns - -`Promise`<{}\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:83 - -___ - -### enqueueExecution - -▸ **enqueueExecution**(`options`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions-1.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:87 - -___ - -### ephemeralEnqueuedExecution - -▸ **ephemeralEnqueuedExecution**(`options`): `Promise`<[`RunNowResult`](../interfaces/client._internal_namespace.RunNowResult.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions-1.md) | - -#### Returns - -`Promise`<[`RunNowResult`](../interfaces/client._internal_namespace.RunNowResult.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:88 - -___ - -### execute - -▸ **execute**(`__namedParameters`): `Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Omit`<[`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions.md)<`unknown`\>, ``"request"``\> | - -#### Returns - -`Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`unknown`\>\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:86 - -___ - -### get - -▸ **get**(`__namedParameters`): `Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> - -Get an action - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.id` | `string` | - -#### Returns - -`Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:69 - -___ - -### getAll - -▸ **getAll**(): `Promise`<[`FindActionResult`](../interfaces/client._internal_namespace.FindActionResult.md)[]\> - -Get all actions with preconfigured list - -#### Returns - -`Promise`<[`FindActionResult`](../interfaces/client._internal_namespace.FindActionResult.md)[]\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:75 - -___ - -### getBulk - -▸ **getBulk**(`ids`): `Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>[]\> - -Get bulk actions with preconfigured list - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ids` | `string`[] | - -#### Returns - -`Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>[]\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:79 - -___ - -### isActionTypeEnabled - -▸ **isActionTypeEnabled**(`actionTypeId`, `options?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionTypeId` | `string` | -| `options?` | `Object` | -| `options.notifyUsage` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:90 - -___ - -### isPreconfigured - -▸ **isPreconfigured**(`connectorId`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `connectorId` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:93 - -___ - -### listTypes - -▸ **listTypes**(): `Promise`<[`ActionType`](../interfaces/client._internal_namespace.ActionType.md)[]\> - -#### Returns - -`Promise`<[`ActionType`](../interfaces/client._internal_namespace.ActionType.md)[]\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:89 - -___ - -### update - -▸ **update**(`__namedParameters`): `Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> - -Update action - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`UpdateOptions`](../interfaces/client._internal_namespace.UpdateOptions.md) | - -#### Returns - -`Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:65 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertService.md deleted file mode 100644 index b231fddac4c619..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertService.md +++ /dev/null @@ -1,206 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertService - -# Class: AlertService - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertService - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.AlertService.md#constructor) - -### Methods - -- [bucketAlertsByIndexAndStatus](client._internal_namespace.AlertService.md#bucketalertsbyindexandstatus) -- [executeAggregations](client._internal_namespace.AlertService.md#executeaggregations) -- [getAlerts](client._internal_namespace.AlertService.md#getalerts) -- [translateStatus](client._internal_namespace.AlertService.md#translatestatus) -- [updateAlertsStatus](client._internal_namespace.AlertService.md#updatealertsstatus) -- [updateByQuery](client._internal_namespace.AlertService.md#updatebyquery) -- [getUniqueIdsIndices](client._internal_namespace.AlertService.md#getuniqueidsindices) -- [isEmptyAlert](client._internal_namespace.AlertService.md#isemptyalert) - -## Constructors - -### constructor - -• **new AlertService**(`scopedClusterClient`, `logger`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scopedClusterClient` | [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) | -| `logger` | `Logger` | - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:24](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L24) - -## Methods - -### bucketAlertsByIndexAndStatus - -▸ `Private` **bucketAlertsByIndexAndStatus**(`alerts`): `Map`<`string`, `Map`<`STATUS_VALUES`, [`TranslatedUpdateAlertRequest`](../interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md)[]\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `alerts` | [`UpdateAlertRequest`](../interfaces/client._internal_namespace.UpdateAlertRequest.md)[] | - -#### Returns - -`Map`<`string`, `Map`<`STATUS_VALUES`, [`TranslatedUpdateAlertRequest`](../interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md)[]\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:98](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L98) - -___ - -### executeAggregations - -▸ **executeAggregations**(`__namedParameters`): `Promise`<[`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.aggregationBuilders` | [`AggregationBuilder`](../interfaces/client._internal_namespace.AggregationBuilder.md)[] | -| `__namedParameters.alerts` | [`AlertIdIndex`](../interfaces/client._internal_namespace.AlertIdIndex.md)[] | - -#### Returns - -`Promise`<[`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse)\> - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L29) - -___ - -### getAlerts - -▸ **getAlerts**(`alertsInfo`): `Promise`<`undefined` \| [`AlertsResponse`](../interfaces/client._internal_namespace.AlertsResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `alertsInfo` | [`AlertInfo`](../interfaces/client._internal_namespace.AlertInfo.md)[] | - -#### Returns - -`Promise`<`undefined` \| [`AlertsResponse`](../interfaces/client._internal_namespace.AlertsResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:182](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L182) - -___ - -### translateStatus - -▸ `Private` **translateStatus**(`alert`): `STATUS_VALUES` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `alert` | [`UpdateAlertRequest`](../interfaces/client._internal_namespace.UpdateAlertRequest.md) | - -#### Returns - -`STATUS_VALUES` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:133](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L133) - -___ - -### updateAlertsStatus - -▸ **updateAlertsStatus**(`alerts`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `alerts` | [`UpdateAlertRequest`](../interfaces/client._internal_namespace.UpdateAlertRequest.md)[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L78) - -___ - -### updateByQuery - -▸ `Private` **updateByQuery**(`__namedParameters`): `Promise`<`TransportResult`<`UpdateByQueryResponse`, `unknown`\>[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`string`, `Map`<`STATUS_VALUES`, [`TranslatedUpdateAlertRequest`](../interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md)[]\>] | - -#### Returns - -`Promise`<`TransportResult`<`UpdateByQueryResponse`, `unknown`\>[]\> - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:151](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L151) - -___ - -### getUniqueIdsIndices - -▸ `Static` `Private` **getUniqueIdsIndices**(`alerts`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `alerts` | [`AlertIdIndex`](../interfaces/client._internal_namespace.AlertIdIndex.md)[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `ids` | `string`[] | -| `indices` | `string`[] | - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:62](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L62) - -___ - -### isEmptyAlert - -▸ `Static` `Private` **isEmptyAlert**(`alert`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `alert` | [`AlertInfo`](../interfaces/client._internal_namespace.AlertInfo.md) | - -#### Returns - -`boolean` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:129](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L129) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertingActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertingActions.md deleted file mode 100644 index 6b45ea9b281100..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertingActions.md +++ /dev/null @@ -1,68 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertingActions - -# Class: AlertingActions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertingActions - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.AlertingActions.md#constructor) - -### Properties - -- [prefix](client._internal_namespace.AlertingActions.md#prefix) - -### Methods - -- [get](client._internal_namespace.AlertingActions.md#get) - -## Constructors - -### constructor - -• **new AlertingActions**(`versionNumber`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionNumber` | `string` | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/alerting.d.ts:3 - -## Properties - -### prefix - -• `Private` `Readonly` **prefix**: `any` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/alerting.d.ts:2 - -## Methods - -### get - -▸ **get**(`ruleTypeId`, `consumer`, `alertingEntity`, `operation`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ruleTypeId` | `string` | -| `consumer` | `string` | -| `alertingEntity` | `string` | -| `operation` | `string` | - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/alerting.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ApiActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ApiActions.md deleted file mode 100644 index a7e6c51d4a649a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ApiActions.md +++ /dev/null @@ -1,65 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ApiActions - -# Class: ApiActions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ApiActions - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.ApiActions.md#constructor) - -### Properties - -- [prefix](client._internal_namespace.ApiActions.md#prefix) - -### Methods - -- [get](client._internal_namespace.ApiActions.md#get) - -## Constructors - -### constructor - -• **new ApiActions**(`versionNumber`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionNumber` | `string` | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/api.d.ts:3 - -## Properties - -### prefix - -• `Private` `Readonly` **prefix**: `any` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/api.d.ts:2 - -## Methods - -### get - -▸ **get**(`operation`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation` | `string` | - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/api.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AppActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AppActions.md deleted file mode 100644 index 76fbfc84021c51..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AppActions.md +++ /dev/null @@ -1,65 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AppActions - -# Class: AppActions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AppActions - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.AppActions.md#constructor) - -### Properties - -- [prefix](client._internal_namespace.AppActions.md#prefix) - -### Methods - -- [get](client._internal_namespace.AppActions.md#get) - -## Constructors - -### constructor - -• **new AppActions**(`versionNumber`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionNumber` | `string` | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/app.d.ts:3 - -## Properties - -### prefix - -• `Private` `Readonly` **prefix**: `any` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/app.d.ts:2 - -## Methods - -### get - -▸ **get**(`appId`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `appId` | `string` | - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/app.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AttachmentService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AttachmentService.md deleted file mode 100644 index 064f9cf9567b34..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AttachmentService.md +++ /dev/null @@ -1,217 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AttachmentService - -# Class: AttachmentService - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AttachmentService - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.AttachmentService.md#constructor) - -### Methods - -- [buildCountAlertsAggs](client._internal_namespace.AttachmentService.md#buildcountalertsaggs) -- [bulkUpdate](client._internal_namespace.AttachmentService.md#bulkupdate) -- [countAlertsAttachedToCase](client._internal_namespace.AttachmentService.md#countalertsattachedtocase) -- [create](client._internal_namespace.AttachmentService.md#create) -- [delete](client._internal_namespace.AttachmentService.md#delete) -- [executeCaseActionsAggregations](client._internal_namespace.AttachmentService.md#executecaseactionsaggregations) -- [get](client._internal_namespace.AttachmentService.md#get) -- [getAllAlertsAttachToCase](client._internal_namespace.AttachmentService.md#getallalertsattachtocase) -- [update](client._internal_namespace.AttachmentService.md#update) - -## Constructors - -### constructor - -• **new AttachmentService**(`log`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Logger` | - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:66](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L66) - -## Methods - -### buildCountAlertsAggs - -▸ `Private` **buildCountAlertsAggs**(): `Record`<`string`, `AggregationsAggregationContainer`\> - -#### Returns - -`Record`<`string`, `AggregationsAggregationContainer`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:104](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L104) - -___ - -### bulkUpdate - -▸ **bulkUpdate**(`__namedParameters`): `Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BulkUpdateAttachmentArgs`](../interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:262](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L262) - -___ - -### countAlertsAttachedToCase - -▸ **countAlertsAttachedToCase**(`__namedParameters`): `Promise`<`undefined` \| `number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`AttachedToCaseArgs`](../interfaces/client._internal_namespace.AttachedToCaseArgs.md) | - -#### Returns - -`Promise`<`undefined` \| `number`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:68](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L68) - -___ - -### create - -▸ **create**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateAttachmentArgs`](../interfaces/client._internal_namespace.CreateAttachmentArgs.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:220](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L220) - -___ - -### delete - -▸ **delete**(`__namedParameters`): `Promise`<{}\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetAttachmentArgs`](../interfaces/client._internal_namespace.GetAttachmentArgs.md) | - -#### Returns - -`Promise`<{}\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:210](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L210) - -___ - -### executeCaseActionsAggregations - -▸ **executeCaseActionsAggregations**(`__namedParameters`): `Promise`<[`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse)\> - -Executes the aggregations against the actions attached to a case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CountActionsAttachedToCaseArgs`](../interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md) | - -#### Returns - -`Promise`<[`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse)\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:157](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L157) - -___ - -### get - -▸ **get**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetAttachmentArgs`](../interfaces/client._internal_namespace.GetAttachmentArgs.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:194](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L194) - -___ - -### getAllAlertsAttachToCase - -▸ **getAllAlertsAttachToCase**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>[]\> - -Retrieves all the alerts attached to a case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`AttachedToCaseArgs`](../interfaces/client._internal_namespace.AttachedToCaseArgs.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>[]\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:117](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L117) - -___ - -### update - -▸ **update**(`__namedParameters`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`UpdateAttachmentArgs`](../modules/client._internal_namespace.md#updateattachmentargs) | - -#### Returns - -`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:242](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L242) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Authorization.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Authorization.md deleted file mode 100644 index 7c09e59f2216ad..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Authorization.md +++ /dev/null @@ -1,241 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Authorization - -# Class: Authorization - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Authorization - -This class handles ensuring that the user making a request has the correct permissions -for the API request. - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.Authorization.md#constructor) - -### Properties - -- [auditLogger](client._internal_namespace.Authorization.md#auditlogger) -- [featureCaseOwners](client._internal_namespace.Authorization.md#featurecaseowners) -- [request](client._internal_namespace.Authorization.md#request) -- [securityAuth](client._internal_namespace.Authorization.md#securityauth) - -### Methods - -- [\_ensureAuthorized](client._internal_namespace.Authorization.md#_ensureauthorized) -- [\_getAuthorizationFilter](client._internal_namespace.Authorization.md#_getauthorizationfilter) -- [ensureAuthorized](client._internal_namespace.Authorization.md#ensureauthorized) -- [getAuthorizationFilter](client._internal_namespace.Authorization.md#getauthorizationfilter) -- [getAuthorizedOwners](client._internal_namespace.Authorization.md#getauthorizedowners) -- [shouldCheckAuthorization](client._internal_namespace.Authorization.md#shouldcheckauthorization) -- [create](client._internal_namespace.Authorization.md#create) - -## Constructors - -### constructor - -• `Private` **new Authorization**(`__namedParameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.auditLogger` | [`AuthorizationAuditLogger`](client._internal_namespace.AuthorizationAuditLogger.md) | -| `__namedParameters.caseOwners` | `Set`<`string`\> | -| `__namedParameters.request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | -| `__namedParameters.securityAuth?` | [`AuthorizationServiceSetup`](../interfaces/client._internal_namespace.AuthorizationServiceSetup.md) | - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:27](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L27) - -## Properties - -### auditLogger - -• `Private` `Readonly` **auditLogger**: [`AuthorizationAuditLogger`](client._internal_namespace.AuthorizationAuditLogger.md) - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L25) - -___ - -### featureCaseOwners - -• `Private` `Readonly` **featureCaseOwners**: `Set`<`string`\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:24](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L24) - -___ - -### request - -• `Private` `Readonly` **request**: [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L22) - -___ - -### securityAuth - -• `Private` `Readonly` **securityAuth**: `undefined` \| [`AuthorizationServiceSetup`](../interfaces/client._internal_namespace.AuthorizationServiceSetup.md) - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:23](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L23) - -## Methods - -### \_ensureAuthorized - -▸ `Private` **_ensureAuthorized**(`owners`, `operation`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owners` | `string`[] | -| `operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:135](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L135) - -___ - -### \_getAuthorizationFilter - -▸ `Private` **_getAuthorizationFilter**(`operation`): `Promise`<[`AuthFilterHelpers`](../interfaces/client._internal_namespace.AuthFilterHelpers.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | - -#### Returns - -`Promise`<[`AuthFilterHelpers`](../interfaces/client._internal_namespace.AuthFilterHelpers.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:170](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L170) - -___ - -### ensureAuthorized - -▸ **ensureAuthorized**(`__namedParameters`): `Promise`<`void`\> - -Checks that the user making the request for the passed in owners and operation has the correct authorization. This -function will throw if the user is not authorized for the requested operation and owners. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.entities` | [`OwnerEntity`](../interfaces/client._internal_namespace.OwnerEntity.md)[] | -| `__namedParameters.operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:97](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L97) - -___ - -### getAuthorizationFilter - -▸ **getAuthorizationFilter**(`operation`): `Promise`<[`AuthFilterHelpers`](../interfaces/client._internal_namespace.AuthFilterHelpers.md)\> - -Returns an object to filter the saved object find request to the authorized owners of an entity. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | - -#### Returns - -`Promise`<[`AuthFilterHelpers`](../interfaces/client._internal_namespace.AuthFilterHelpers.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:126](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L126) - -___ - -### getAuthorizedOwners - -▸ `Private` **getAuthorizedOwners**(`operations`): `Promise`<{ `authorizedOwners`: `string`[] ; `hasAllRequested`: `boolean` ; `username?`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operations` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md)[] | - -#### Returns - -`Promise`<{ `authorizedOwners`: `string`[] ; `hasAllRequested`: `boolean` ; `username?`: `string` }\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:207](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L207) - -___ - -### shouldCheckAuthorization - -▸ `Private` **shouldCheckAuthorization**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L85) - -___ - -### create - -▸ `Static` **create**(`__namedParameters`): `Promise`<[`Authorization`](client._internal_namespace.Authorization.md)\> - -Creates an Authorization object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.auditLogger` | [`AuthorizationAuditLogger`](client._internal_namespace.AuthorizationAuditLogger.md) | -| `__namedParameters.features` | [`PluginStartContract`](../interfaces/client._internal_namespace.PluginStartContract.md) | -| `__namedParameters.getSpace` | [`GetSpaceFn`](../modules/client._internal_namespace.md#getspacefn) | -| `__namedParameters.logger` | `Logger` | -| `__namedParameters.request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | -| `__namedParameters.securityAuth?` | [`AuthorizationServiceSetup`](../interfaces/client._internal_namespace.AuthorizationServiceSetup.md) | - -#### Returns - -`Promise`<[`Authorization`](client._internal_namespace.Authorization.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/authorization.ts:47](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L47) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AuthorizationAuditLogger.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AuthorizationAuditLogger.md deleted file mode 100644 index 5f80d4d21f4b29..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AuthorizationAuditLogger.md +++ /dev/null @@ -1,117 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthorizationAuditLogger - -# Class: AuthorizationAuditLogger - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthorizationAuditLogger - -Audit logger for authorization operations - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.AuthorizationAuditLogger.md#constructor) - -### Properties - -- [auditLogger](client._internal_namespace.AuthorizationAuditLogger.md#auditlogger) - -### Methods - -- [log](client._internal_namespace.AuthorizationAuditLogger.md#log) -- [createAuditMsg](client._internal_namespace.AuthorizationAuditLogger.md#createauditmsg) -- [createFailureMessage](client._internal_namespace.AuthorizationAuditLogger.md#createfailuremessage) - -## Constructors - -### constructor - -• **new AuthorizationAuditLogger**(`logger?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `logger?` | [`AuditLogger`](../interfaces/client._internal_namespace.AuditLogger.md) | - -#### Defined in - -[x-pack/plugins/cases/server/authorization/audit_logger.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L25) - -## Properties - -### auditLogger - -• `Private` `Optional` `Readonly` **auditLogger**: [`AuditLogger`](../interfaces/client._internal_namespace.AuditLogger.md) - -#### Defined in - -[x-pack/plugins/cases/server/authorization/audit_logger.ts:23](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L23) - -## Methods - -### log - -▸ **log**(`auditMsgParams`): `void` - -Logs an audit event based on the status of an operation. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `auditMsgParams` | [`CreateAuditMsgParams`](../interfaces/client._internal_namespace.CreateAuditMsgParams.md) | - -#### Returns - -`void` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/audit_logger.ts:98](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L98) - -___ - -### createAuditMsg - -▸ `Static` `Private` **createAuditMsg**(`__namedParameters`): [`AuditEvent`](../interfaces/client._internal_namespace.AuditEvent.md) - -Creates an AuditEvent describing the state of a request. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateAuditMsgParams`](../interfaces/client._internal_namespace.CreateAuditMsgParams.md) | - -#### Returns - -[`AuditEvent`](../interfaces/client._internal_namespace.AuditEvent.md) - -#### Defined in - -[x-pack/plugins/cases/server/authorization/audit_logger.ts:32](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L32) - -___ - -### createFailureMessage - -▸ `Static` **createFailureMessage**(`__namedParameters`): `string` - -Creates a message to be passed to an Error or Boom. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | -| `__namedParameters.owners` | `string`[] | - -#### Returns - -`string` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/audit_logger.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L79) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BasePath.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BasePath.md deleted file mode 100644 index 50d50b457bfead..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BasePath.md +++ /dev/null @@ -1,189 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BasePath - -# Class: BasePath - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BasePath - -Access or manipulate the Kibana base path - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.BasePath.md#constructor) - -### Properties - -- [basePathCache](client._internal_namespace.BasePath.md#basepathcache) -- [get](client._internal_namespace.BasePath.md#get) -- [prepend](client._internal_namespace.BasePath.md#prepend) -- [publicBaseUrl](client._internal_namespace.BasePath.md#publicbaseurl) -- [remove](client._internal_namespace.BasePath.md#remove) -- [serverBasePath](client._internal_namespace.BasePath.md#serverbasepath) -- [set](client._internal_namespace.BasePath.md#set) - -## Constructors - -### constructor - -• **new BasePath**(`serverBasePath?`, `publicBaseUrl?`) - -**`internal`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `serverBasePath?` | `string` | -| `publicBaseUrl?` | `string` | - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:24 - -## Properties - -### basePathCache - -• `Private` `Readonly` **basePathCache**: `any` - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:8 - -___ - -### get - -• **get**: (`request`: [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\>) => `string` - -#### Type declaration - -▸ (`request`): `string` - -returns `basePath` value, specific for an incoming request. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | - -##### Returns - -`string` - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:28 - -___ - -### prepend - -• **prepend**: (`path`: `string`) => `string` - -#### Type declaration - -▸ (`path`): `string` - -Prepends `path` with the basePath. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | - -##### Returns - -`string` - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:38 - -___ - -### publicBaseUrl - -• `Optional` `Readonly` **publicBaseUrl**: `string` - -The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the -[BasePath.serverBasePath](client._internal_namespace.BasePath.md#serverbasepath). - -**`remarks`** -Should be used for generating external URL links back to this Kibana instance. - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:22 - -___ - -### remove - -• **remove**: (`path`: `string`) => `string` - -#### Type declaration - -▸ (`path`): `string` - -Removes the prepended basePath from the `path`. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string` | - -##### Returns - -`string` - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:42 - -___ - -### serverBasePath - -• `Readonly` **serverBasePath**: `string` - -returns the server's basePath - -See [BasePath.get](client._internal_namespace.BasePath.md#get) for getting the basePath value for a specific request - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:14 - -___ - -### set - -• **set**: (`request`: [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\>, `requestSpecificBasePath`: `string`) => `void` - -#### Type declaration - -▸ (`request`, `requestSpecificBasePath`): `void` - -sets `basePath` value, specific for an incoming request. - -**`privateremarks`** should work only for KibanaRequest as soon as spaces migrate to NP - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | -| `requestSpecificBasePath` | `string` | - -##### Returns - -`void` - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:34 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BuilderFactory.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BuilderFactory.md deleted file mode 100644 index a6f48bc77918b9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BuilderFactory.md +++ /dev/null @@ -1,47 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BuilderFactory - -# Class: BuilderFactory - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BuilderFactory - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.BuilderFactory.md#constructor) - -### Methods - -- [getBuilder](client._internal_namespace.BuilderFactory.md#getbuilder) - -## Constructors - -### constructor - -• **new BuilderFactory**() - -## Methods - -### getBuilder - -▸ **getBuilder**<`T`\>(`type`): `undefined` \| [`UserActionBuilder`](client._internal_namespace.UserActionBuilder.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends ``"description"`` \| ``"tags"`` \| ``"title"`` \| ``"connector"`` \| ``"settings"`` \| ``"status"`` \| ``"comment"`` \| ``"pushed"`` \| ``"create_case"`` \| ``"delete_case"`` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `T` | - -#### Returns - -`undefined` \| [`UserActionBuilder`](client._internal_namespace.UserActionBuilder.md) - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/builder_factory.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/builder_factory.ts#L35) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseConfigureService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseConfigureService.md deleted file mode 100644 index bf61548e826ce5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseConfigureService.md +++ /dev/null @@ -1,135 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CaseConfigureService - -# Class: CaseConfigureService - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CaseConfigureService - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.CaseConfigureService.md#constructor) - -### Methods - -- [delete](client._internal_namespace.CaseConfigureService.md#delete) -- [find](client._internal_namespace.CaseConfigureService.md#find) -- [get](client._internal_namespace.CaseConfigureService.md#get) -- [patch](client._internal_namespace.CaseConfigureService.md#patch) -- [post](client._internal_namespace.CaseConfigureService.md#post) - -## Constructors - -### constructor - -• **new CaseConfigureService**(`log`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Logger` | - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:52](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L52) - -## Methods - -### delete - -▸ **delete**(`__namedParameters`): `Promise`<{}\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetCaseConfigureArgs`](../interfaces/client._internal_namespace.GetCaseConfigureArgs.md) | - -#### Returns - -`Promise`<{}\> - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:54](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L54) - -___ - -### find - -▸ **find**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`FindCaseConfigureArgs`](../interfaces/client._internal_namespace.FindCaseConfigureArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:82](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L82) - -___ - -### get - -▸ **get**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetCaseConfigureArgs`](../interfaces/client._internal_namespace.GetCaseConfigureArgs.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:64](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L64) - -___ - -### patch - -▸ **patch**(`__namedParameters`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `closure_type`: `undefined` \| ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: `undefined` \| { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = CaseConnectorRt } & { `version`: `string` = rt.string }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`PatchCaseConfigureArgs`](../interfaces/client._internal_namespace.PatchCaseConfigureArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `closure_type`: `undefined` \| ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: `undefined` \| { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = CaseConnectorRt } & { `version`: `string` = rt.string }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:125](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L125) - -___ - -### post - -▸ **post**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`PostCaseConfigureArgs`](../interfaces/client._internal_namespace.PostCaseConfigureArgs.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:104](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L104) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseUserActionService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseUserActionService.md deleted file mode 100644 index ed34d0f5389b78..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseUserActionService.md +++ /dev/null @@ -1,304 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CaseUserActionService - -# Class: CaseUserActionService - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CaseUserActionService - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.CaseUserActionService.md#constructor) - -### Properties - -- [builderFactory](client._internal_namespace.CaseUserActionService.md#builderfactory) -- [userActionFieldsAllowed](client._internal_namespace.CaseUserActionService.md#useractionfieldsallowed) - -### Methods - -- [buildCountConnectorsAggs](client._internal_namespace.CaseUserActionService.md#buildcountconnectorsaggs) -- [bulkCreate](client._internal_namespace.CaseUserActionService.md#bulkcreate) -- [bulkCreateAttachmentDeletion](client._internal_namespace.CaseUserActionService.md#bulkcreateattachmentdeletion) -- [bulkCreateCaseDeletion](client._internal_namespace.CaseUserActionService.md#bulkcreatecasedeletion) -- [bulkCreateUpdateCase](client._internal_namespace.CaseUserActionService.md#bulkcreateupdatecase) -- [create](client._internal_namespace.CaseUserActionService.md#create) -- [createUserAction](client._internal_namespace.CaseUserActionService.md#createuseraction) -- [findStatusChanges](client._internal_namespace.CaseUserActionService.md#findstatuschanges) -- [getAll](client._internal_namespace.CaseUserActionService.md#getall) -- [getUniqueConnectors](client._internal_namespace.CaseUserActionService.md#getuniqueconnectors) -- [getUserActionItemByDifference](client._internal_namespace.CaseUserActionService.md#getuseractionitembydifference) - -## Constructors - -### constructor - -• **new CaseUserActionService**(`log`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Logger` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:106](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L106) - -## Properties - -### builderFactory - -• `Private` `Readonly` **builderFactory**: [`BuilderFactory`](client._internal_namespace.BuilderFactory.md) - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:104](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L104) - -___ - -### userActionFieldsAllowed - -▪ `Static` `Private` `Readonly` **userActionFieldsAllowed**: `Set`<`string`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:102](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L102) - -## Methods - -### buildCountConnectorsAggs - -▸ `Private` **buildCountConnectorsAggs**(`size?`): `Record`<`string`, `AggregationsAggregationContainer`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `size` | `number` | `100` | - -#### Returns - -`Record`<`string`, `AggregationsAggregationContainer`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:470](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L470) - -___ - -### bulkCreate - -▸ **bulkCreate**(`__namedParameters`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`PostCaseUserActionArgs`](../interfaces/client._internal_namespace.PostCaseUserActionArgs.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:352](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L352) - -___ - -### bulkCreateAttachmentDeletion - -▸ **bulkCreateAttachmentDeletion**(`__namedParameters`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BulkCreateAttachmentDeletionUserAction`](../interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:244](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L244) - -___ - -### bulkCreateCaseDeletion - -▸ **bulkCreateCaseDeletion**(`__namedParameters`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BulkCreateCaseDeletionUserAction`](../interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:171](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L171) - -___ - -### bulkCreateUpdateCase - -▸ **bulkCreateUpdateCase**(`__namedParameters`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BulkCreateBulkUpdateCaseUserActions`](../interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:198](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L198) - -___ - -### create - -▸ **create**<`T`\>(`__namedParameters`): `Promise`<`void`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateUserActionES`](../interfaces/client._internal_namespace.CreateUserActionES.md)<`T`\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:335](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L335) - -___ - -### createUserAction - -▸ **createUserAction**<`T`\>(`__namedParameters`): `Promise`<`void`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends keyof [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateUserActionClient`](../modules/client._internal_namespace.md#createuseractionclient)<`T`\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:275](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L275) - -___ - -### findStatusChanges - -▸ **findStatusChanges**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `payload`: { description: string; } = DescriptionUserActionPayloadRt; `type`: ``"description"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { comment: { comment: string; type: CommentType.user; owner: string; } \| { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } \| { ...; }; } = CommentUserActionPayloadRt; `type`: ``"comment"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { tags: string[]; } = TagsUserActionPayloadRt; `type`: ``"tags"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { title: string; } = TitleUserActionPayloadRt; `type`: ``"title"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { settings: { syncAlerts: boolean; }; } = SettingsUserActionPayloadRt; `type`: ``"settings"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { status: CaseStatuses; } = StatusUserActionPayloadRt; `type`: ``"status"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `type`: ``"create_case"`` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } & { description: string; status: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } = ConnectorUserActionPayloadRt; `type`: ``"connector"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { externalService: { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; }; } = PushedUserActionPayloadRt; `type`: ``"pushed"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: {} ; `type`: ``"delete_case"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` }\>[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.caseId` | `string` | -| `__namedParameters.filter?` | `KueryNode` | -| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `payload`: { description: string; } = DescriptionUserActionPayloadRt; `type`: ``"description"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { comment: { comment: string; type: CommentType.user; owner: string; } \| { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } \| { ...; }; } = CommentUserActionPayloadRt; `type`: ``"comment"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { tags: string[]; } = TagsUserActionPayloadRt; `type`: ``"tags"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { title: string; } = TitleUserActionPayloadRt; `type`: ``"title"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { settings: { syncAlerts: boolean; }; } = SettingsUserActionPayloadRt; `type`: ``"settings"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { status: CaseStatuses; } = StatusUserActionPayloadRt; `type`: ``"status"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `type`: ``"create_case"`` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } & { description: string; status: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } = ConnectorUserActionPayloadRt; `type`: ``"connector"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { externalService: { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; }; } = PushedUserActionPayloadRt; `type`: ``"pushed"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: {} ; `type`: ``"delete_case"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` }\>[]\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:372](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L372) - -___ - -### getAll - -▸ **getAll**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `payload`: { description: string; } = DescriptionUserActionPayloadRt; `type`: ``"description"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { comment: { comment: string; type: CommentType.user; owner: string; } \| { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } \| { ...; }; } = CommentUserActionPayloadRt; `type`: ``"comment"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { tags: string[]; } = TagsUserActionPayloadRt; `type`: ``"tags"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { title: string; } = TitleUserActionPayloadRt; `type`: ``"title"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { settings: { syncAlerts: boolean; }; } = SettingsUserActionPayloadRt; `type`: ``"settings"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { status: CaseStatuses; } = StatusUserActionPayloadRt; `type`: ``"status"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `type`: ``"create_case"`` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } & { description: string; status: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } = ConnectorUserActionPayloadRt; `type`: ``"connector"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { externalService: { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; }; } = PushedUserActionPayloadRt; `type`: ``"pushed"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: {} ; `type`: ``"delete_case"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` }, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetCaseUserActionArgs`](../interfaces/client._internal_namespace.GetCaseUserActionArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `payload`: { description: string; } = DescriptionUserActionPayloadRt; `type`: ``"description"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { comment: { comment: string; type: CommentType.user; owner: string; } \| { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } \| { ...; }; } = CommentUserActionPayloadRt; `type`: ``"comment"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { tags: string[]; } = TagsUserActionPayloadRt; `type`: ``"tags"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { title: string; } = TitleUserActionPayloadRt; `type`: ``"title"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { settings: { syncAlerts: boolean; }; } = SettingsUserActionPayloadRt; `type`: ``"settings"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { status: CaseStatuses; } = StatusUserActionPayloadRt; `type`: ``"status"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `type`: ``"create_case"`` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } & { description: string; status: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } = ConnectorUserActionPayloadRt; `type`: ``"connector"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { externalService: { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; }; } = PushedUserActionPayloadRt; `type`: ``"pushed"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: {} ; `type`: ``"delete_case"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` }, `unknown`\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:310](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L310) - -___ - -### getUniqueConnectors - -▸ **getUniqueConnectors**(`__namedParameters`): `Promise`<{ `id`: `string` }[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.caseId` | `string` | -| `__namedParameters.filter?` | `KueryNode` | -| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | - -#### Returns - -`Promise`<{ `id`: `string` }[]\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:426](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L426) - -___ - -### getUserActionItemByDifference - -▸ `Private` **getUserActionItemByDifference**(`__namedParameters`): [`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetUserActionItemByDifference`](../interfaces/client._internal_namespace.GetUserActionItemByDifference.md) | - -#### Returns - -[`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:108](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L108) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesActions.md deleted file mode 100644 index 40c474c66fc371..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesActions.md +++ /dev/null @@ -1,66 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesActions - -# Class: CasesActions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesActions - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.CasesActions.md#constructor) - -### Properties - -- [prefix](client._internal_namespace.CasesActions.md#prefix) - -### Methods - -- [get](client._internal_namespace.CasesActions.md#get) - -## Constructors - -### constructor - -• **new CasesActions**(`versionNumber`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionNumber` | `string` | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/cases.d.ts:3 - -## Properties - -### prefix - -• `Private` `Readonly` **prefix**: `any` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/cases.d.ts:2 - -## Methods - -### get - -▸ **get**(`owner`, `operation`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | `string` | -| `operation` | `string` | - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/cases.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesClientInternal.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesClientInternal.md deleted file mode 100644 index 9a7fe6f6c11d5a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesClientInternal.md +++ /dev/null @@ -1,59 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesClientInternal - -# Class: CasesClientInternal - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesClientInternal - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.CasesClientInternal.md#constructor) - -### Properties - -- [\_configuration](client._internal_namespace.CasesClientInternal.md#_configuration) - -### Accessors - -- [configuration](client._internal_namespace.CasesClientInternal.md#configuration) - -## Constructors - -### constructor - -• **new CasesClientInternal**(`args`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | - -#### Defined in - -[x-pack/plugins/cases/server/client/client_internal.ts:17](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client_internal.ts#L17) - -## Properties - -### \_configuration - -• `Private` `Readonly` **\_configuration**: `InternalConfigureSubClient` - -#### Defined in - -[x-pack/plugins/cases/server/client/client_internal.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client_internal.ts#L15) - -## Accessors - -### configuration - -• `get` **configuration**(): `InternalConfigureSubClient` - -#### Returns - -`InternalConfigureSubClient` - -#### Defined in - -[x-pack/plugins/cases/server/client/client_internal.ts:21](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client_internal.ts#L21) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesService.md deleted file mode 100644 index eb31fa2722c151..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesService.md +++ /dev/null @@ -1,470 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesService - -# Class: CasesService - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesService - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.CasesService.md#constructor) - -### Methods - -- [asArray](client._internal_namespace.CasesService.md#asarray) -- [buildCaseIdsAggs](client._internal_namespace.CasesService.md#buildcaseidsaggs) -- [deleteCase](client._internal_namespace.CasesService.md#deletecase) -- [findCaseStatusStats](client._internal_namespace.CasesService.md#findcasestatusstats) -- [findCases](client._internal_namespace.CasesService.md#findcases) -- [findCasesGroupedByID](client._internal_namespace.CasesService.md#findcasesgroupedbyid) -- [getAllCaseComments](client._internal_namespace.CasesService.md#getallcasecomments) -- [getAllComments](client._internal_namespace.CasesService.md#getallcomments) -- [getCase](client._internal_namespace.CasesService.md#getcase) -- [getCaseCommentStats](client._internal_namespace.CasesService.md#getcasecommentstats) -- [getCaseIdsByAlertId](client._internal_namespace.CasesService.md#getcaseidsbyalertid) -- [getCases](client._internal_namespace.CasesService.md#getcases) -- [getReporters](client._internal_namespace.CasesService.md#getreporters) -- [getResolveCase](client._internal_namespace.CasesService.md#getresolvecase) -- [getTags](client._internal_namespace.CasesService.md#gettags) -- [getUser](client._internal_namespace.CasesService.md#getuser) -- [patchCase](client._internal_namespace.CasesService.md#patchcase) -- [patchCases](client._internal_namespace.CasesService.md#patchcases) -- [postNewCase](client._internal_namespace.CasesService.md#postnewcase) -- [getCaseIDsFromAlertAggs](client._internal_namespace.CasesService.md#getcaseidsfromalertaggs) - -## Constructors - -### constructor - -• **new CasesService**(`log`, `authentication?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Logger` | -| `authentication?` | `Object` | -| `authentication.getCurrentUser` | (`request`: [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\>) => ``null`` \| [`AuthenticatedUser`](../interfaces/client._internal_namespace.AuthenticatedUser.md) | - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:138](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L138) - -## Methods - -### asArray - -▸ `Private` **asArray**(`id`): `string`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `undefined` \| `string` \| `string`[] | - -#### Returns - -`string`[] - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:413](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L413) - -___ - -### buildCaseIdsAggs - -▸ `Private` **buildCaseIdsAggs**(`size?`): `Record`<`string`, `AggregationsAggregationContainer`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `size` | `number` | `100` | - -#### Returns - -`Record`<`string`, `AggregationsAggregationContainer`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:143](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L143) - -___ - -### deleteCase - -▸ **deleteCase**(`__namedParameters`): `Promise`<{}\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetCaseArgs`](../interfaces/client._internal_namespace.GetCaseArgs.md) | - -#### Returns - -`Promise`<{}\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:332](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L332) - -___ - -### findCaseStatusStats - -▸ **findCaseStatusStats**(`__namedParameters`): `Promise`<`number`\> - -Retrieves the number of cases that exist with a given status (open, closed, etc). - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.caseOptions` | [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) | -| `__namedParameters.ensureSavedObjectsAreAuthorized` | [`EnsureSOAuthCallback`](../modules/client._internal_namespace.md#ensuresoauthcallback) | -| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:251](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L251) - -___ - -### findCases - -▸ **findCases**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`FindCasesArgs`](../interfaces/client._internal_namespace.FindCasesArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:395](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L395) - -___ - -### findCasesGroupedByID - -▸ **findCasesGroupedByID**(`__namedParameters`): `Promise`<[`CasesMapWithPageInfo`](../interfaces/client._internal_namespace.CasesMapWithPageInfo.md)\> - -Returns a map of all cases. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.caseOptions` | [`FindCaseOptions`](../modules/client._internal_namespace.md#findcaseoptions) | -| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | - -#### Returns - -`Promise`<[`CasesMapWithPageInfo`](../interfaces/client._internal_namespace.CasesMapWithPageInfo.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:206](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L206) - -___ - -### getAllCaseComments - -▸ **getAllCaseComments**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> - -Default behavior is to retrieve all comments that adhere to a given filter (if one is included). -to override this pass in the either the page or perPage options. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`FindCaseCommentsArgs`](../interfaces/client._internal_namespace.FindCaseCommentsArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:455](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L455) - -___ - -### getAllComments - -▸ `Private` **getAllComments**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`FindCommentsArgs`](../interfaces/client._internal_namespace.FindCommentsArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:423](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L423) - -___ - -### getCase - -▸ **getCase**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetCaseArgs`](../interfaces/client._internal_namespace.GetCaseArgs.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:342](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L342) - -___ - -### getCaseCommentStats - -▸ **getCaseCommentStats**(`__namedParameters`): `Promise`<[`CaseCommentStats`](../interfaces/client._internal_namespace.CaseCommentStats.md)\> - -Returns the number of total comments and alerts for a case - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.ids` | `string`[] | -| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | - -#### Returns - -`Promise`<[`CaseCommentStats`](../interfaces/client._internal_namespace.CaseCommentStats.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:280](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L280) - -___ - -### getCaseIdsByAlertId - -▸ **getCaseIdsByAlertId**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, { `references`: { doc\_count: number; caseIds: { buckets: { key: string; }[]; }; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetCaseIdsByAlertIdArgs`](../interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, { `references`: { doc\_count: number; caseIds: { buckets: { key: string; }[]; }; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:161](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L161) - -___ - -### getCases - -▸ **getCases**(`__namedParameters`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetCasesArgs`](../interfaces/client._internal_namespace.GetCasesArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:379](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L379) - -___ - -### getReporters - -▸ **getReporters**(`__namedParameters`): `Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` }[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetReportersArgs`](../interfaces/client._internal_namespace.GetReportersArgs.md) | - -#### Returns - -`Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` }[]\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:488](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L488) - -___ - -### getResolveCase - -▸ **getResolveCase**(`__namedParameters`): `Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetCaseArgs`](../interfaces/client._internal_namespace.GetCaseArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:359](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L359) - -___ - -### getTags - -▸ **getTags**(`__namedParameters`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetTagsArgs`](../interfaces/client._internal_namespace.GetTagsArgs.md) | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:552](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L552) - -___ - -### getUser - -▸ **getUser**(`__namedParameters`): [`AuthenticatedUser`](../interfaces/client._internal_namespace.AuthenticatedUser.md) \| { `email`: ``null`` = null; `full_name`: ``null`` = null; `username`: ``null`` = null } - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetUserArgs`](../interfaces/client._internal_namespace.GetUserArgs.md) | - -#### Returns - -[`AuthenticatedUser`](../interfaces/client._internal_namespace.AuthenticatedUser.md) \| { `email`: ``null`` = null; `full_name`: ``null`` = null; `username`: ``null`` = null } - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:582](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L582) - -___ - -### patchCase - -▸ **patchCase**(`__namedParameters`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`PatchCaseArgs`](../modules/client._internal_namespace.md#patchcaseargs) | - -#### Returns - -`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:627](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L627) - -___ - -### patchCases - -▸ **patchCases**(`__namedParameters`): `Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`PatchCasesArgs`](../interfaces/client._internal_namespace.PatchCasesArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:655](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L655) - -___ - -### postNewCase - -▸ **postNewCase**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`PostCaseArgs`](../interfaces/client._internal_namespace.PostCaseArgs.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:607](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L607) - -___ - -### getCaseIDsFromAlertAggs - -▸ `Static` **getCaseIDsFromAlertAggs**(`result`): `string`[] - -Extracts the case IDs from the alert aggregation - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `result` | [`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, { `references`: { doc\_count: number; caseIds: { buckets: { key: string; }[]; }; } }\> | - -#### Returns - -`string`[] - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:197](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L197) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorMappingsService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorMappingsService.md deleted file mode 100644 index 2b6649eca41118..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorMappingsService.md +++ /dev/null @@ -1,93 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConnectorMappingsService - -# Class: ConnectorMappingsService - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConnectorMappingsService - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.ConnectorMappingsService.md#constructor) - -### Methods - -- [find](client._internal_namespace.ConnectorMappingsService.md#find) -- [post](client._internal_namespace.ConnectorMappingsService.md#post) -- [update](client._internal_namespace.ConnectorMappingsService.md#update) - -## Constructors - -### constructor - -• **new ConnectorMappingsService**(`log`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Logger` | - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:33](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L33) - -## Methods - -### find - -▸ **find**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`FindConnectorMappingsArgs`](../interfaces/client._internal_namespace.FindConnectorMappingsArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }, `unknown`\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L35) - -___ - -### post - -▸ **post**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`PostConnectorMappingsArgs`](../interfaces/client._internal_namespace.PostConnectorMappingsArgs.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:48](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L48) - -___ - -### update - -▸ **update**(`__namedParameters`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`UpdateConnectorMappingsArgs`](../interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md) | - -#### Returns - -`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\>\> - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:68](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L68) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorTokenClient.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorTokenClient.md deleted file mode 100644 index 7e2a19e11efbec..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorTokenClient.md +++ /dev/null @@ -1,162 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConnectorTokenClient - -# Class: ConnectorTokenClient - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConnectorTokenClient - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.ConnectorTokenClient.md#constructor) - -### Properties - -- [encryptedSavedObjectsClient](client._internal_namespace.ConnectorTokenClient.md#encryptedsavedobjectsclient) -- [logger](client._internal_namespace.ConnectorTokenClient.md#logger) -- [unsecuredSavedObjectsClient](client._internal_namespace.ConnectorTokenClient.md#unsecuredsavedobjectsclient) - -### Methods - -- [create](client._internal_namespace.ConnectorTokenClient.md#create) -- [deleteConnectorTokens](client._internal_namespace.ConnectorTokenClient.md#deleteconnectortokens) -- [get](client._internal_namespace.ConnectorTokenClient.md#get) -- [update](client._internal_namespace.ConnectorTokenClient.md#update) - -## Constructors - -### constructor - -• **new ConnectorTokenClient**(`__namedParameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ConstructorOptions`](../interfaces/client._internal_namespace.ConstructorOptions-2.md) | - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:26 - -## Properties - -### encryptedSavedObjectsClient - -• `Private` `Readonly` **encryptedSavedObjectsClient**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:25 - -___ - -### logger - -• `Private` `Readonly` **logger**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:23 - -___ - -### unsecuredSavedObjectsClient - -• `Private` `Readonly` **unsecuredSavedObjectsClient**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:24 - -## Methods - -### create - -▸ **create**(`__namedParameters`): `Promise`<[`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md)\> - -Create new token for connector - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateOptions`](../interfaces/client._internal_namespace.CreateOptions-1.md) | - -#### Returns - -`Promise`<[`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:30 - -___ - -### deleteConnectorTokens - -▸ **deleteConnectorTokens**(`__namedParameters`): `Promise`<{}[]\> - -Delete all connector tokens - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.connectorId` | `string` | -| `__namedParameters.tokenType?` | `string` | - -#### Returns - -`Promise`<{}[]\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:48 - -___ - -### get - -▸ **get**(`__namedParameters`): `Promise`<{ `connectorToken`: ``null`` \| [`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md) ; `hasErrors`: `boolean` }\> - -Get connector token - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.connectorId` | `string` | -| `__namedParameters.tokenType?` | `string` | - -#### Returns - -`Promise`<{ `connectorToken`: ``null`` \| [`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md) ; `hasErrors`: `boolean` }\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:38 - -___ - -### update - -▸ **update**(`__namedParameters`): `Promise`<``null`` \| [`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md)\> - -Update connector token - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`UpdateOptions`](../interfaces/client._internal_namespace.UpdateOptions-1.md) | - -#### Returns - -`Promise`<``null`` \| [`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:34 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ElasticsearchFeature.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ElasticsearchFeature.md deleted file mode 100644 index 95ffabe03d9833..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ElasticsearchFeature.md +++ /dev/null @@ -1,122 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ElasticsearchFeature - -# Class: ElasticsearchFeature - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ElasticsearchFeature - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.ElasticsearchFeature.md#constructor) - -### Properties - -- [config](client._internal_namespace.ElasticsearchFeature.md#config) - -### Accessors - -- [catalogue](client._internal_namespace.ElasticsearchFeature.md#catalogue) -- [id](client._internal_namespace.ElasticsearchFeature.md#id) -- [management](client._internal_namespace.ElasticsearchFeature.md#management) -- [privileges](client._internal_namespace.ElasticsearchFeature.md#privileges) - -### Methods - -- [toRaw](client._internal_namespace.ElasticsearchFeature.md#toraw) - -## Constructors - -### constructor - -• **new ElasticsearchFeature**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `Readonly`<{ `catalogue?`: `RecursiveReadonlyArray`<`string`\> ; `id`: `string` ; `management?`: `Readonly`<{ [x: string]: RecursiveReadonlyArray; }\> ; `privileges`: `RecursiveReadonlyArray`<[`FeatureElasticsearchPrivileges`](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md)\> }\> | - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:54 - -## Properties - -### config - -• `Protected` `Readonly` **config**: `Readonly`<{ `catalogue?`: `RecursiveReadonlyArray`<`string`\> ; `id`: `string` ; `management?`: `Readonly`<{ [x: string]: RecursiveReadonlyArray; }\> ; `privileges`: `RecursiveReadonlyArray`<[`FeatureElasticsearchPrivileges`](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md)\> }\> - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:53 - -## Accessors - -### catalogue - -• `get` **catalogue**(): `undefined` \| `RecursiveReadonlyArray`<`string`\> - -#### Returns - -`undefined` \| `RecursiveReadonlyArray`<`string`\> - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:56 - -___ - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:55 - -___ - -### management - -• `get` **management**(): `undefined` \| `Readonly`<{ [x: string]: `RecursiveReadonlyArray`; }\> - -#### Returns - -`undefined` \| `Readonly`<{ [x: string]: `RecursiveReadonlyArray`; }\> - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:57 - -___ - -### privileges - -• `get` **privileges**(): `RecursiveReadonlyArray`<[`FeatureElasticsearchPrivileges`](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md)\> - -#### Returns - -`RecursiveReadonlyArray`<[`FeatureElasticsearchPrivileges`](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md)\> - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:60 - -## Methods - -### toRaw - -▸ **toRaw**(): [`ElasticsearchFeatureConfig`](../interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md) - -#### Returns - -[`ElasticsearchFeatureConfig`](../interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md) - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:61 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaFeature.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaFeature.md deleted file mode 100644 index 88e1f958de6dcc..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaFeature.md +++ /dev/null @@ -1,268 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaFeature - -# Class: KibanaFeature - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaFeature - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.KibanaFeature.md#constructor) - -### Properties - -- [config](client._internal_namespace.KibanaFeature.md#config) -- [subFeatures](client._internal_namespace.KibanaFeature.md#subfeatures) - -### Accessors - -- [alerting](client._internal_namespace.KibanaFeature.md#alerting) -- [app](client._internal_namespace.KibanaFeature.md#app) -- [cases](client._internal_namespace.KibanaFeature.md#cases) -- [catalogue](client._internal_namespace.KibanaFeature.md#catalogue) -- [category](client._internal_namespace.KibanaFeature.md#category) -- [excludeFromBasePrivileges](client._internal_namespace.KibanaFeature.md#excludefrombaseprivileges) -- [id](client._internal_namespace.KibanaFeature.md#id) -- [management](client._internal_namespace.KibanaFeature.md#management) -- [minimumLicense](client._internal_namespace.KibanaFeature.md#minimumlicense) -- [name](client._internal_namespace.KibanaFeature.md#name) -- [order](client._internal_namespace.KibanaFeature.md#order) -- [privileges](client._internal_namespace.KibanaFeature.md#privileges) -- [reserved](client._internal_namespace.KibanaFeature.md#reserved) - -### Methods - -- [toRaw](client._internal_namespace.KibanaFeature.md#toraw) - -## Constructors - -### constructor - -• **new KibanaFeature**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `Readonly`<{ `alerting?`: readonly `string`[] ; `app`: readonly `string`[] ; `cases?`: readonly `string`[] ; `catalogue?`: readonly `string`[] ; `category`: `Readonly`<{ id: string; label: string; ariaLabel?: string \| undefined; order?: number \| undefined; euiIconType?: string \| undefined; }\> ; `excludeFromBasePrivileges?`: `boolean` ; `id`: `string` ; `management?`: `Readonly`<{ [x: string]: readonly string[]; }\> ; `minimumLicense?`: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` ; `name`: `string` ; `order?`: `number` ; `privileges`: ``null`` \| `Readonly`<{ all: Readonly<{ excludeFromBasePrivileges?: boolean \| undefined; requireAllSpaces?: boolean \| undefined; disabled?: boolean \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 6 more ...; ui: readonly string[]; }\>; read: Readonly<...\>; }\> ; `privilegesTooltip?`: `string` ; `reserved?`: `Readonly`<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean \| undefined; requireAllSpaces?: boolean \| undefined; disabled?: boolean \| undefined; ... 7 more ...; ui: readonly string[]; }\>; }\>[]; }\> ; `subFeatures?`: readonly `Readonly`<{ name: string; privilegeGroups: readonly Readonly<{ groupType: SubFeaturePrivilegeGroupType; privileges: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; ... 10 more ...; ui: readonly string[]; }\>[]; }\>[]; }\>[] }\> | - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:123 - -## Properties - -### config - -• `Protected` `Readonly` **config**: `Readonly`<{ `alerting?`: readonly `string`[] ; `app`: readonly `string`[] ; `cases?`: readonly `string`[] ; `catalogue?`: readonly `string`[] ; `category`: `Readonly`<{ id: string; label: string; ariaLabel?: string \| undefined; order?: number \| undefined; euiIconType?: string \| undefined; }\> ; `excludeFromBasePrivileges?`: `boolean` ; `id`: `string` ; `management?`: `Readonly`<{ [x: string]: readonly string[]; }\> ; `minimumLicense?`: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` ; `name`: `string` ; `order?`: `number` ; `privileges`: ``null`` \| `Readonly`<{ all: Readonly<{ excludeFromBasePrivileges?: boolean \| undefined; requireAllSpaces?: boolean \| undefined; disabled?: boolean \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 6 more ...; ui: readonly string[]; }\>; read: Readonly<...\>; }\> ; `privilegesTooltip?`: `string` ; `reserved?`: `Readonly`<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean \| undefined; requireAllSpaces?: boolean \| undefined; disabled?: boolean \| undefined; ... 7 more ...; ui: readonly string[]; }\>; }\>[]; }\> ; `subFeatures?`: readonly `Readonly`<{ name: string; privilegeGroups: readonly Readonly<{ groupType: SubFeaturePrivilegeGroupType; privileges: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; ... 10 more ...; ui: readonly string[]; }\>[]; }\>[]; }\>[] }\> - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:121 - -___ - -### subFeatures - -• `Readonly` **subFeatures**: [`SubFeature`](client._internal_namespace.SubFeature.md)[] - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:122 - -## Accessors - -### alerting - -• `get` **alerting**(): `undefined` \| readonly `string`[] - -#### Returns - -`undefined` \| readonly `string`[] - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:202 - -___ - -### app - -• `get` **app**(): readonly `string`[] - -#### Returns - -readonly `string`[] - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:134 - -___ - -### cases - -• `get` **cases**(): `undefined` \| readonly `string`[] - -#### Returns - -`undefined` \| readonly `string`[] - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:203 - -___ - -### catalogue - -• `get` **catalogue**(): `undefined` \| readonly `string`[] - -#### Returns - -`undefined` \| readonly `string`[] - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:135 - -___ - -### category - -• `get` **category**(): `Readonly`<{ `ariaLabel?`: `string` ; `euiIconType?`: `string` ; `id`: `string` ; `label`: `string` ; `order?`: `number` }\> - -#### Returns - -`Readonly`<{ `ariaLabel?`: `string` ; `euiIconType?`: `string` ; `id`: `string` ; `label`: `string` ; `order?`: `number` }\> - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:127 - -___ - -### excludeFromBasePrivileges - -• `get` **excludeFromBasePrivileges**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:204 - -___ - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:124 - -___ - -### management - -• `get` **management**(): `undefined` \| `Readonly`<{ [x: string]: readonly `string`[]; }\> - -#### Returns - -`undefined` \| `Readonly`<{ [x: string]: readonly `string`[]; }\> - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:136 - -___ - -### minimumLicense - -• `get` **minimumLicense**(): `undefined` \| ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -#### Returns - -`undefined` \| ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:139 - -___ - -### name - -• `get` **name**(): `string` - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:125 - -___ - -### order - -• `get` **order**(): `undefined` \| `number` - -#### Returns - -`undefined` \| `number` - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:126 - -___ - -### privileges - -• `get` **privileges**(): ``null`` \| `Readonly`<{ `all`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> }\> ; `api?`: readonly `string`[] ; `app?`: readonly `string`[] ; `cases?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `catalogue?`: readonly `string`[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly `string`[] ; `read`: readonly `string`[] }\> ; `ui`: readonly `string`[] }\> ; `read`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> }\> ; `api?`: readonly `string`[] ; `app?`: readonly `string`[] ; `cases?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `catalogue?`: readonly `string`[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly `string`[] ; `read`: readonly `string`[] }\> ; `ui`: readonly `string`[] }\> }\> - -#### Returns - -``null`` \| `Readonly`<{ `all`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> }\> ; `api?`: readonly `string`[] ; `app?`: readonly `string`[] ; `cases?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `catalogue?`: readonly `string`[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly `string`[] ; `read`: readonly `string`[] }\> ; `ui`: readonly `string`[] }\> ; `read`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> }\> ; `api?`: readonly `string`[] ; `app?`: readonly `string`[] ; `cases?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `catalogue?`: readonly `string`[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly `string`[] ; `read`: readonly `string`[] }\> ; `ui`: readonly `string`[] }\> }\> - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:140 - -___ - -### reserved - -• `get` **reserved**(): `undefined` \| `Readonly`<{ `description`: `string` ; `privileges`: readonly `Readonly`<{ `id`: `string` ; `privilege`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> }\> ; `api?`: readonly string[] ; `app?`: readonly string[] ; `cases?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> ; `catalogue?`: readonly string[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly string[] ; `read`: readonly string[] }\> ; `ui`: readonly string[] }\> }\>[] }\> - -#### Returns - -`undefined` \| `Readonly`<{ `description`: `string` ; `privileges`: readonly `Readonly`<{ `id`: `string` ; `privilege`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> }\> ; `api?`: readonly string[] ; `app?`: readonly string[] ; `cases?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> ; `catalogue?`: readonly string[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly string[] ; `read`: readonly string[] }\> ; `ui`: readonly string[] }\> }\>[] }\> - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:205 - -## Methods - -### toRaw - -▸ **toRaw**(): [`KibanaFeatureConfig`](../interfaces/client._internal_namespace.KibanaFeatureConfig.md) - -#### Returns - -[`KibanaFeatureConfig`](../interfaces/client._internal_namespace.KibanaFeatureConfig.md) - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:241 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaMigrator.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaMigrator.md deleted file mode 100644 index a26089d3ed6f43..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaMigrator.md +++ /dev/null @@ -1,286 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaMigrator - -# Class: KibanaMigrator - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaMigrator - -Manages the shape of mappings and documents in the Kibana index. - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.KibanaMigrator.md#constructor) - -### Properties - -- [activeMappings](client._internal_namespace.KibanaMigrator.md#activemappings) -- [client](client._internal_namespace.KibanaMigrator.md#client) -- [documentMigrator](client._internal_namespace.KibanaMigrator.md#documentmigrator) -- [kibanaIndex](client._internal_namespace.KibanaMigrator.md#kibanaindex) -- [kibanaVersion](client._internal_namespace.KibanaMigrator.md#kibanaversion) -- [log](client._internal_namespace.KibanaMigrator.md#log) -- [mappingProperties](client._internal_namespace.KibanaMigrator.md#mappingproperties) -- [migrationResult](client._internal_namespace.KibanaMigrator.md#migrationresult) -- [runMigrationsInternal](client._internal_namespace.KibanaMigrator.md#runmigrationsinternal) -- [serializer](client._internal_namespace.KibanaMigrator.md#serializer) -- [soMigrationsConfig](client._internal_namespace.KibanaMigrator.md#somigrationsconfig) -- [status$](client._internal_namespace.KibanaMigrator.md#status$) -- [typeRegistry](client._internal_namespace.KibanaMigrator.md#typeregistry) - -### Methods - -- [getActiveMappings](client._internal_namespace.KibanaMigrator.md#getactivemappings) -- [getStatus$](client._internal_namespace.KibanaMigrator.md#getstatus$) -- [migrateDocument](client._internal_namespace.KibanaMigrator.md#migratedocument) -- [prepareMigrations](client._internal_namespace.KibanaMigrator.md#preparemigrations) -- [runMigrations](client._internal_namespace.KibanaMigrator.md#runmigrations) - -## Constructors - -### constructor - -• **new KibanaMigrator**(`__namedParameters`) - -Creates an instance of KibanaMigrator. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`KibanaMigratorOptions`](../interfaces/client._internal_namespace.KibanaMigratorOptions.md) | - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:42 - -## Properties - -### activeMappings - -• `Private` `Readonly` **activeMappings**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:36 - -___ - -### client - -• `Private` `Readonly` **client**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:27 - -___ - -### documentMigrator - -• `Private` `Readonly` **documentMigrator**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:28 - -___ - -### kibanaIndex - -• `Private` `Readonly` **kibanaIndex**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:29 - -___ - -### kibanaVersion - -• `Readonly` **kibanaVersion**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:38 - -___ - -### log - -• `Private` `Readonly` **log**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:30 - -___ - -### mappingProperties - -• `Private` `Readonly` **mappingProperties**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:31 - -___ - -### migrationResult - -• `Private` `Optional` **migrationResult**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:34 - -___ - -### runMigrationsInternal - -• `Private` **runMigrationsInternal**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:68 - -___ - -### serializer - -• `Private` `Readonly` **serializer**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:33 - -___ - -### soMigrationsConfig - -• `Private` `Readonly` **soMigrationsConfig**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:37 - -___ - -### status$ - -• `Private` `Readonly` **status$**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:35 - -___ - -### typeRegistry - -• `Private` `Readonly` **typeRegistry**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:32 - -## Methods - -### getActiveMappings - -▸ **getActiveMappings**(): [`IndexMapping`](../interfaces/client._internal_namespace.IndexMapping.md) - -Gets all the index mappings defined by Kibana's enabled plugins. - -#### Returns - -[`IndexMapping`](../interfaces/client._internal_namespace.IndexMapping.md) - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:73 - -___ - -### getStatus$ - -▸ **getStatus$**(): `Observable`<[`KibanaMigratorStatus`](../interfaces/client._internal_namespace.KibanaMigratorStatus.md)\> - -#### Returns - -`Observable`<[`KibanaMigratorStatus`](../interfaces/client._internal_namespace.KibanaMigratorStatus.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:67 - -___ - -### migrateDocument - -▸ **migrateDocument**(`doc`): [`SavedObjectUnsanitizedDoc`](../modules/client._internal_namespace.md#savedobjectunsanitizeddoc)<`unknown`\> - -Migrates an individual doc to the latest version, as defined by the plugin migrations. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `doc` | [`SavedObjectUnsanitizedDoc`](../modules/client._internal_namespace.md#savedobjectunsanitizeddoc)<`unknown`\> | The saved object to migrate | - -#### Returns - -[`SavedObjectUnsanitizedDoc`](../modules/client._internal_namespace.md#savedobjectunsanitizeddoc)<`unknown`\> - -`doc` with all registered migrations applied. - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:80 - -___ - -### prepareMigrations - -▸ **prepareMigrations**(): `void` - -#### Returns - -`void` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:66 - -___ - -### runMigrations - -▸ **runMigrations**(`rerun?`): `Promise`<{ `status`: `string` }[]\> - -Migrates the mappings and documents in the Kibana index. By default, this will run only -once and subsequent calls will return the result of the original call. - -**`remarks`** When the `rerun` parameter is set to true, no checks are performed to ensure that no migration -is currently running. Chained or concurrent calls to `runMigrations({ rerun: true })` can lead to -multiple migrations running at the same time. When calling with this parameter, it's expected that the calling -code should ensure that the initial call resolves before calling the function again. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `rerun?` | `Object` | If true, method will run a new migration when called again instead of returning the result of the initial migration. This should only be used when factors external to Kibana itself alter the kibana index causing the saved objects mappings or data to change after the Kibana server performed the initial migration. | -| `rerun.rerun?` | `boolean` | - | - -#### Returns - -`Promise`<{ `status`: `string` }[]\> - -- A promise which resolves once all migrations have been applied. - The promise resolves with an array of migration statuses, one for each - elasticsearch index which was migrated. - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:61 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaRequest.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaRequest.md deleted file mode 100644 index e0aae4835d6b78..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaRequest.md +++ /dev/null @@ -1,347 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaRequest - -# Class: KibanaRequest - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaRequest - -Kibana specific abstraction for an incoming request. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Params` | `unknown` | -| `Query` | `unknown` | -| `Body` | `unknown` | -| `Method` | extends [`RouteMethod`](../modules/client._internal_namespace.md#routemethod) = `any` | - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.KibanaRequest.md#constructor) - -### Properties - -- [[requestSymbol]](client._internal_namespace.KibanaRequest.md#[requestsymbol]) -- [auth](client._internal_namespace.KibanaRequest.md#auth) -- [body](client._internal_namespace.KibanaRequest.md#body) -- [events](client._internal_namespace.KibanaRequest.md#events) -- [getAuthRequired](client._internal_namespace.KibanaRequest.md#getauthrequired) -- [getEvents](client._internal_namespace.KibanaRequest.md#getevents) -- [getRouteInfo](client._internal_namespace.KibanaRequest.md#getrouteinfo) -- [headers](client._internal_namespace.KibanaRequest.md#headers) -- [id](client._internal_namespace.KibanaRequest.md#id) -- [isSystemRequest](client._internal_namespace.KibanaRequest.md#issystemrequest) -- [params](client._internal_namespace.KibanaRequest.md#params) -- [query](client._internal_namespace.KibanaRequest.md#query) -- [rewrittenUrl](client._internal_namespace.KibanaRequest.md#rewrittenurl) -- [route](client._internal_namespace.KibanaRequest.md#route) -- [socket](client._internal_namespace.KibanaRequest.md#socket) -- [url](client._internal_namespace.KibanaRequest.md#url) -- [uuid](client._internal_namespace.KibanaRequest.md#uuid) -- [withoutSecretHeaders](client._internal_namespace.KibanaRequest.md#withoutsecretheaders) -- [validate](client._internal_namespace.KibanaRequest.md#validate) - -### Methods - -- [from](client._internal_namespace.KibanaRequest.md#from) - -## Constructors - -### constructor - -• **new KibanaRequest**<`Params`, `Query`, `Body`, `Method`\>(`request`, `params`, `query`, `body`, `withoutSecretHeaders`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Params` | `unknown` | -| `Query` | `unknown` | -| `Body` | `unknown` | -| `Method` | extends [`RouteMethod`](../modules/client._internal_namespace.md#routemethod) = `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `Request` | -| `params` | `Params` | -| `query` | `Query` | -| `body` | `Body` | -| `withoutSecretHeaders` | `boolean` | - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:126 - -## Properties - -### [requestSymbol] - -• `Protected` `Readonly` **[requestSymbol]**: `Request` - -**`internal`** - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:125 - -___ - -### auth - -• `Readonly` **auth**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `isAuthenticated` | `boolean` | - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:117 - -___ - -### body - -• `Readonly` **body**: `Body` - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:66 - -___ - -### events - -• `Readonly` **events**: [`KibanaRequestEvents`](../interfaces/client._internal_namespace.KibanaRequestEvents.md) - -Request events [KibanaRequestEvents](../interfaces/client._internal_namespace.KibanaRequestEvents.md) - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:116 - -___ - -### getAuthRequired - -• `Private` **getAuthRequired**: `any` - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:129 - -___ - -### getEvents - -• `Private` **getEvents**: `any` - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:127 - -___ - -### getRouteInfo - -• `Private` **getRouteInfo**: `any` - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:128 - -___ - -### headers - -• `Readonly` **headers**: [`Headers`](../modules/client._internal_namespace.md#headers) - -Readonly copy of incoming request headers. - -**`remarks`** -This property will contain a `filtered` copy of request headers. - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:107 - -___ - -### id - -• `Readonly` **id**: `string` - -A identifier to identify this request. - -**`remarks`** -Depending on the user's configuration, this value may be sourced from the -incoming request's `X-Opaque-Id` header which is not guaranteed to be unique -per request. - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:89 - -___ - -### isSystemRequest - -• `Readonly` **isSystemRequest**: `boolean` - -Whether or not the request is a "system request" rather than an application-level request. -Can be set on the client using the `HttpFetchOptions#asSystemRequest` option. - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:112 - -___ - -### params - -• `Readonly` **params**: `Params` - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:64 - -___ - -### query - -• `Readonly` **query**: `Query` - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:65 - -___ - -### rewrittenUrl - -• `Optional` `Readonly` **rewrittenUrl**: `URL` - -URL rewritten in onPreRouting request interceptor. - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:123 - -___ - -### route - -• `Readonly` **route**: `Readonly`<{ `method`: `RecursiveReadonly`<`Method`\> ; `options`: `RecursiveReadonly`<[`KibanaRequestRouteOptions`](../modules/client._internal_namespace.md#kibanarequestrouteoptions)<`Method`\>\> ; `path`: `string` }\> - -matched route details - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:101 - -___ - -### socket - -• `Readonly` **socket**: [`IKibanaSocket`](../interfaces/client._internal_namespace.IKibanaSocket.md) - -[IKibanaSocket](../interfaces/client._internal_namespace.IKibanaSocket.md) - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:114 - -___ - -### url - -• `Readonly` **url**: `URL` - -a WHATWG URL standard object. - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:99 - -___ - -### uuid - -• `Readonly` **uuid**: `string` - -A UUID to identify this request. - -**`remarks`** -This value is NOT sourced from the incoming request's `X-Opaque-Id` header. it -is always a UUID uniquely identifying the request. - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:97 - -___ - -### withoutSecretHeaders - -• `Private` `Readonly` **withoutSecretHeaders**: `any` - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:67 - -___ - -### validate - -▪ `Static` `Private` **validate**: `any` - -Validates the different parts of a request based on the schemas defined for -the route. Builds up the actual params, query and body object that will be -received in the route handler. - -**`internal`** - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:80 - -## Methods - -### from - -▸ `Static` **from**<`P`, `Q`, `B`\>(`req`, `routeSchemas?`, `withoutSecretHeaders?`): [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`P`, `Q`, `B`, `any`\> - -Factory for creating requests. Validates the request before creating an -instance of a KibanaRequest. - -**`internal`** - -#### Type parameters - -| Name | -| :------ | -| `P` | -| `Q` | -| `B` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `req` | `Request` | -| `routeSchemas?` | [`RouteValidator`](client._internal_namespace.RouteValidator.md)<`P`, `Q`, `B`\> \| [`RouteValidatorFullConfig`](../modules/client._internal_namespace.md#routevalidatorfullconfig)<`P`, `Q`, `B`\> | -| `withoutSecretHeaders?` | `boolean` | - -#### Returns - -[`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`P`, `Q`, `B`, `any`\> - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:73 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.LicenseState.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.LicenseState.md deleted file mode 100644 index 9b8af11cd73cf9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.LicenseState.md +++ /dev/null @@ -1,215 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LicenseState - -# Class: LicenseState - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LicenseState - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.LicenseState.md#constructor) - -### Properties - -- [\_notifyUsage](client._internal_namespace.LicenseState.md#_notifyusage) -- [license](client._internal_namespace.LicenseState.md#license) -- [licenseInformation](client._internal_namespace.LicenseState.md#licenseinformation) -- [notifyUsage](client._internal_namespace.LicenseState.md#notifyusage) -- [subscription](client._internal_namespace.LicenseState.md#subscription) -- [updateInformation](client._internal_namespace.LicenseState.md#updateinformation) - -### Methods - -- [checkLicense](client._internal_namespace.LicenseState.md#checklicense) -- [clean](client._internal_namespace.LicenseState.md#clean) -- [ensureLicenseForActionType](client._internal_namespace.LicenseState.md#ensurelicenseforactiontype) -- [getLicenseInformation](client._internal_namespace.LicenseState.md#getlicenseinformation) -- [isLicenseValidForActionType](client._internal_namespace.LicenseState.md#islicensevalidforactiontype) -- [setNotifyUsage](client._internal_namespace.LicenseState.md#setnotifyusage) - -## Constructors - -### constructor - -• **new LicenseState**(`license$`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `license$` | `Observable`<[`ILicense`](../interfaces/client._internal_namespace.ILicense.md)\> | - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:17 - -## Properties - -### \_notifyUsage - -• `Private` **\_notifyUsage**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:16 - -___ - -### license - -• `Private` `Optional` **license**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:15 - -___ - -### licenseInformation - -• `Private` **licenseInformation**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:13 - -___ - -### notifyUsage - -• `Private` **notifyUsage**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:30 - -___ - -### subscription - -• `Private` **subscription**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:14 - -___ - -### updateInformation - -• `Private` **updateInformation**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:18 - -## Methods - -### checkLicense - -▸ **checkLicense**(`license`): [`ActionsLicenseInformation`](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `license` | `undefined` \| [`ILicense`](../interfaces/client._internal_namespace.ILicense.md) | - -#### Returns - -[`ActionsLicenseInformation`](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:32 - -___ - -### clean - -▸ **clean**(): `void` - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:20 - -___ - -### ensureLicenseForActionType - -▸ **ensureLicenseForActionType**(`actionType`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionType` | [`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets), [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams), `void`\> | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:31 - -___ - -### getLicenseInformation - -▸ **getLicenseInformation**(): [`ActionsLicenseInformation`](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) - -#### Returns - -[`ActionsLicenseInformation`](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:21 - -___ - -### isLicenseValidForActionType - -▸ **isLicenseValidForActionType**(`actionType`, `__namedParameters?`): { `isValid`: ``true`` } \| { `isValid`: ``false`` ; `reason`: ``"unavailable"`` \| ``"expired"`` \| ``"invalid"`` } - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionType` | [`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets), [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams), `void`\> | -| `__namedParameters?` | `Object` | -| `__namedParameters.notifyUsage` | `boolean` | - -#### Returns - -{ `isValid`: ``true`` } \| { `isValid`: ``false`` ; `reason`: ``"unavailable"`` \| ``"expired"`` \| ``"invalid"`` } - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:22 - -___ - -### setNotifyUsage - -▸ **setNotifyUsage**(`notifyUsage`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `notifyUsage` | (`featureName`: `string`, `usedAt?`: `number` \| `Date`) => `void` | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:19 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidationError.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidationError.md deleted file mode 100644 index a9fcf909bd74ae..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidationError.md +++ /dev/null @@ -1,40 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidationError - -# Class: RouteValidationError - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidationError - -Error to return when the validation is not successful. - -## Hierarchy - -- `SchemaTypeError` - - ↳ **`RouteValidationError`** - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.RouteValidationError.md#constructor) - -## Constructors - -### constructor - -• **new RouteValidationError**(`error`, `path?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `string` \| `Error` | -| `path?` | `string`[] | - -#### Overrides - -SchemaTypeError.constructor - -#### Defined in - -src/core/target/types/server/http/router/validator/validator_error.d.ts:7 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidator.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidator.md deleted file mode 100644 index bf73fbda85719f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidator.md +++ /dev/null @@ -1,272 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidator - -# Class: RouteValidator - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidator - -Route validator class to define the validation logic for each new route. - -**`internal`** - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `P` | {} | -| `Q` | {} | -| `B` | {} | - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.RouteValidator.md#constructor) - -### Properties - -- [config](client._internal_namespace.RouteValidator.md#config) -- [customValidation](client._internal_namespace.RouteValidator.md#customvalidation) -- [options](client._internal_namespace.RouteValidator.md#options) -- [preValidateSchema](client._internal_namespace.RouteValidator.md#prevalidateschema) -- [safetyPostchecks](client._internal_namespace.RouteValidator.md#safetypostchecks) -- [safetyPrechecks](client._internal_namespace.RouteValidator.md#safetyprechecks) -- [validate](client._internal_namespace.RouteValidator.md#validate) -- [validateFunction](client._internal_namespace.RouteValidator.md#validatefunction) -- [ResultFactory](client._internal_namespace.RouteValidator.md#resultfactory) - -### Methods - -- [getBody](client._internal_namespace.RouteValidator.md#getbody) -- [getParams](client._internal_namespace.RouteValidator.md#getparams) -- [getQuery](client._internal_namespace.RouteValidator.md#getquery) -- [hasBody](client._internal_namespace.RouteValidator.md#hasbody) -- [from](client._internal_namespace.RouteValidator.md#from) - -## Constructors - -### constructor - -• `Private` **new RouteValidator**<`P`, `Q`, `B`\>() - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `P` | {} | -| `Q` | {} | -| `B` | {} | - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:112 - -## Properties - -### config - -• `Private` `Readonly` **config**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:108 - -___ - -### customValidation - -• `Private` **customValidation**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:136 - -___ - -### options - -• `Private` `Readonly` **options**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:109 - -___ - -### preValidateSchema - -• `Private` **preValidateSchema**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:138 - -___ - -### safetyPostchecks - -• `Private` **safetyPostchecks**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:135 - -___ - -### safetyPrechecks - -• `Private` **safetyPrechecks**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:134 - -___ - -### validate - -• `Private` **validate**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:133 - -___ - -### validateFunction - -• `Private` **validateFunction**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:137 - -___ - -### ResultFactory - -▪ `Static` `Private` **ResultFactory**: `any` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:111 - -## Methods - -### getBody - -▸ **getBody**(`data`, `namespace?`): `Readonly`<`B`\> - -Get validated body - -**`internal`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `unknown` | -| `namespace?` | `string` | - -#### Returns - -`Readonly`<`B`\> - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:127 - -___ - -### getParams - -▸ **getParams**(`data`, `namespace?`): `Readonly`<`P`\> - -Get validated URL params - -**`internal`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `unknown` | -| `namespace?` | `string` | - -#### Returns - -`Readonly`<`P`\> - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:117 - -___ - -### getQuery - -▸ **getQuery**(`data`, `namespace?`): `Readonly`<`Q`\> - -Get validated query params - -**`internal`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `unknown` | -| `namespace?` | `string` | - -#### Returns - -`Readonly`<`Q`\> - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:122 - -___ - -### hasBody - -▸ **hasBody**(): `boolean` - -Has body validation - -**`internal`** - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:132 - -___ - -### from - -▸ `Static` **from**<`_P`, `_Q`, `_B`\>(`opts`): [`RouteValidator`](client._internal_namespace.RouteValidator.md)<`_P`, `_Q`, `_B`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `_P` | {} | -| `_Q` | {} | -| `_B` | {} | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | [`RouteValidator`](client._internal_namespace.RouteValidator.md)<`_P`, `_Q`, `_B`\> \| [`RouteValidatorFullConfig`](../modules/client._internal_namespace.md#routevalidatorfullconfig)<`_P`, `_Q`, `_B`\> | - -#### Returns - -[`RouteValidator`](client._internal_namespace.RouteValidator.md)<`_P`, `_Q`, `_B`\> - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:110 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectActions.md deleted file mode 100644 index cced678be25cc7..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectActions.md +++ /dev/null @@ -1,66 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectActions - -# Class: SavedObjectActions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectActions - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.SavedObjectActions.md#constructor) - -### Properties - -- [prefix](client._internal_namespace.SavedObjectActions.md#prefix) - -### Methods - -- [get](client._internal_namespace.SavedObjectActions.md#get) - -## Constructors - -### constructor - -• **new SavedObjectActions**(`versionNumber`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionNumber` | `string` | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/saved_object.d.ts:3 - -## Properties - -### prefix - -• `Private` `Readonly` **prefix**: `any` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/saved_object.d.ts:2 - -## Methods - -### get - -▸ **get**(`type`, `operation`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `operation` | `string` | - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/saved_object.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectTypeRegistry.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectTypeRegistry.md deleted file mode 100644 index bc38c9d6773b13..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectTypeRegistry.md +++ /dev/null @@ -1,306 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectTypeRegistry - -# Class: SavedObjectTypeRegistry - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectTypeRegistry - -Registry holding information about all the registered [saved object types](../interfaces/client._internal_namespace.SavedObjectsType.md). - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.SavedObjectTypeRegistry.md#constructor) - -### Properties - -- [types](client._internal_namespace.SavedObjectTypeRegistry.md#types) - -### Methods - -- [getAllTypes](client._internal_namespace.SavedObjectTypeRegistry.md#getalltypes) -- [getImportableAndExportableTypes](client._internal_namespace.SavedObjectTypeRegistry.md#getimportableandexportabletypes) -- [getIndex](client._internal_namespace.SavedObjectTypeRegistry.md#getindex) -- [getType](client._internal_namespace.SavedObjectTypeRegistry.md#gettype) -- [getVisibleTypes](client._internal_namespace.SavedObjectTypeRegistry.md#getvisibletypes) -- [isHidden](client._internal_namespace.SavedObjectTypeRegistry.md#ishidden) -- [isImportableAndExportable](client._internal_namespace.SavedObjectTypeRegistry.md#isimportableandexportable) -- [isMultiNamespace](client._internal_namespace.SavedObjectTypeRegistry.md#ismultinamespace) -- [isNamespaceAgnostic](client._internal_namespace.SavedObjectTypeRegistry.md#isnamespaceagnostic) -- [isShareable](client._internal_namespace.SavedObjectTypeRegistry.md#isshareable) -- [isSingleNamespace](client._internal_namespace.SavedObjectTypeRegistry.md#issinglenamespace) -- [registerType](client._internal_namespace.SavedObjectTypeRegistry.md#registertype) - -## Constructors - -### constructor - -• **new SavedObjectTypeRegistry**() - -## Properties - -### types - -• `Private` `Readonly` **types**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:14 - -## Methods - -### getAllTypes - -▸ **getAllTypes**(): [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] - -Return all [types](../interfaces/client._internal_namespace.SavedObjectsType.md) currently registered, including the hidden ones. - -To only get the visible types (which is the most common use case), use `getVisibleTypes` instead. - -#### Returns - -[`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:35 - -___ - -### getImportableAndExportableTypes - -▸ **getImportableAndExportableTypes**(): [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] - -Return all [types](../interfaces/client._internal_namespace.SavedObjectsType.md) currently registered that are importable/exportable. - -#### Returns - -[`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:39 - -___ - -### getIndex - -▸ **getIndex**(`type`): `undefined` \| `string` - -Returns the `indexPattern` property for given type, or `undefined` if -the type is not registered. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:69 - -___ - -### getType - -▸ **getType**(`type`): `undefined` \| [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\> - -Return the [type](../interfaces/client._internal_namespace.SavedObjectsType.md) definition for given type name. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`undefined` \| [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\> - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:23 - -___ - -### getVisibleTypes - -▸ **getVisibleTypes**(): [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] - -Returns all visible [types](../interfaces/client._internal_namespace.SavedObjectsType.md). - -A visible type is a type that doesn't explicitly define `hidden=true` during registration. - -#### Returns - -[`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:29 - -___ - -### isHidden - -▸ **isHidden**(`type`): `boolean` - -Returns the `hidden` property for given type, or `false` if -the type is not registered. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:64 - -___ - -### isImportableAndExportable - -▸ **isImportableAndExportable**(`type`): `boolean` - -Returns the `management.importableAndExportable` property for given type, or -`false` if the type is not registered or does not define a management section. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:74 - -___ - -### isMultiNamespace - -▸ **isMultiNamespace**(`type`): `boolean` - -Returns whether the type is multi-namespace (shareable *or* isolated); -resolves to `false` if the type is not registered - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:54 - -___ - -### isNamespaceAgnostic - -▸ **isNamespaceAgnostic**(`type`): `boolean` - -Returns whether the type is namespace-agnostic (global); -resolves to `false` if the type is not registered - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:44 - -___ - -### isShareable - -▸ **isShareable**(`type`): `boolean` - -Returns whether the type is multi-namespace (shareable); -resolves to `false` if the type is not registered - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:59 - -___ - -### isSingleNamespace - -▸ **isSingleNamespace**(`type`): `boolean` - -Returns whether the type is single-namespace (isolated); -resolves to `true` if the type is not registered - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:49 - -___ - -### registerType - -▸ **registerType**(`type`): `void` - -Register a [type](../interfaces/client._internal_namespace.SavedObjectsType.md) inside the registry. -A type can only be registered once. subsequent calls with the same type name will throw an error. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\> | - -#### Returns - -`void` - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:19 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsClient.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsClient.md deleted file mode 100644 index 1d97deadff81a1..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsClient.md +++ /dev/null @@ -1,617 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsClient - -# Class: SavedObjectsClient - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsClient - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.SavedObjectsClient.md#constructor) - -### Properties - -- [\_repository](client._internal_namespace.SavedObjectsClient.md#_repository) -- [errors](client._internal_namespace.SavedObjectsClient.md#errors) -- [errors](client._internal_namespace.SavedObjectsClient.md#errors) - -### Methods - -- [bulkCreate](client._internal_namespace.SavedObjectsClient.md#bulkcreate) -- [bulkGet](client._internal_namespace.SavedObjectsClient.md#bulkget) -- [bulkResolve](client._internal_namespace.SavedObjectsClient.md#bulkresolve) -- [bulkUpdate](client._internal_namespace.SavedObjectsClient.md#bulkupdate) -- [checkConflicts](client._internal_namespace.SavedObjectsClient.md#checkconflicts) -- [closePointInTime](client._internal_namespace.SavedObjectsClient.md#closepointintime) -- [collectMultiNamespaceReferences](client._internal_namespace.SavedObjectsClient.md#collectmultinamespacereferences) -- [create](client._internal_namespace.SavedObjectsClient.md#create) -- [createPointInTimeFinder](client._internal_namespace.SavedObjectsClient.md#createpointintimefinder) -- [delete](client._internal_namespace.SavedObjectsClient.md#delete) -- [find](client._internal_namespace.SavedObjectsClient.md#find) -- [get](client._internal_namespace.SavedObjectsClient.md#get) -- [openPointInTimeForType](client._internal_namespace.SavedObjectsClient.md#openpointintimefortype) -- [removeReferencesTo](client._internal_namespace.SavedObjectsClient.md#removereferencesto) -- [resolve](client._internal_namespace.SavedObjectsClient.md#resolve) -- [update](client._internal_namespace.SavedObjectsClient.md#update) -- [updateObjectsSpaces](client._internal_namespace.SavedObjectsClient.md#updateobjectsspaces) - -## Constructors - -### constructor - -• **new SavedObjectsClient**(`repository`) - -**`internal`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `repository` | [`ISavedObjectsRepository`](../modules/client._internal_namespace.md#isavedobjectsrepository) | - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:371 - -## Properties - -### \_repository - -• `Private` **\_repository**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:369 - -___ - -### errors - -• **errors**: typeof [`SavedObjectsErrorHelpers`](client._internal_namespace.SavedObjectsErrorHelpers.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:368 - -___ - -### errors - -▪ `Static` **errors**: typeof [`SavedObjectsErrorHelpers`](client._internal_namespace.SavedObjectsErrorHelpers.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:367 - -## Methods - -### bulkCreate - -▸ **bulkCreate**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> - -Persists multiple documents batched together as a single request - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `objects` | [`SavedObjectsBulkCreateObject`](../interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md)<`T`\>[] | -| `options?` | [`SavedObjectsCreateOptions`](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:386 - -___ - -### bulkGet - -▸ **bulkGet**<`T`\>(`objects?`, `options?`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> - -Returns an array of objects by id - -**`example`** - -bulkGet([ - { id: 'one', type: 'config' }, - { id: 'foo', type: 'index-pattern' } -]) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objects?` | [`SavedObjectsBulkGetObject`](../interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md)[] | an array of ids, or an array of objects containing id, type and optionally fields | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - | - -#### Returns - -`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:420 - -___ - -### bulkResolve - -▸ **bulkResolve**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md)<`T`\>\> - -Resolves an array of objects by id, using any legacy URL aliases if they exist - -**`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. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objects` | [`SavedObjectsBulkResolveObject`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md)[] | an array of objects containing id, type | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - | - -#### Returns - -`Promise`<[`SavedObjectsBulkResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:444 - -___ - -### bulkUpdate - -▸ **bulkUpdate**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<`T`\>\> - -Bulk Updates multiple SavedObject at once - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `objects` | [`SavedObjectsBulkUpdateObject`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md)<`T`\>[] | -| `options?` | [`SavedObjectsBulkUpdateOptions`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:466 - -___ - -### checkConflicts - -▸ **checkConflicts**(`objects?`, `options?`): `Promise`<[`SavedObjectsCheckConflictsResponse`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md)\> - -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. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `objects?` | [`SavedObjectsCheckConflictsObject`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md)[] | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsCheckConflictsResponse`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:394 - -___ - -### closePointInTime - -▸ **closePointInTime**(`id`, `options?`): `Promise`<[`SavedObjectsClosePointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md)\> - -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 [SavedObjectsClient.openPointInTimeForType](client._internal_namespace.SavedObjectsClient.md#openpointintimefortype). - -Only use this API if you have an advanced use case that's not solved by the -[SavedObjectsClient.createPointInTimeFinder](client._internal_namespace.SavedObjectsClient.md#createpointintimefinder) method. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsClosePointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:488 - -___ - -### collectMultiNamespaceReferences - -▸ **collectMultiNamespaceReferences**(`objects`, `options?`): `Promise`<[`SavedObjectsCollectMultiNamespaceReferencesResponse`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md)\> - -Gets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `objects` | [`SavedObjectsCollectMultiNamespaceReferencesObject`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md)[] | -| `options?` | [`SavedObjectsCollectMultiNamespaceReferencesOptions`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsCollectMultiNamespaceReferencesResponse`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:541 - -___ - -### create - -▸ **create**<`T`\>(`type`, `attributes`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -Persists a SavedObject - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `attributes` | `T` | -| `options?` | [`SavedObjectsCreateOptions`](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:379 - -___ - -### createPointInTimeFinder - -▸ **createPointInTimeFinder**<`T`, `A`\>(`findOptions`, `dependencies?`): [`ISavedObjectsPointInTimeFinder`](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md)<`T`, `A`\> - -Returns a [ISavedObjectsPointInTimeFinder](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md) 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 [SavedObjectsClient.find](client._internal_namespace.SavedObjectsClient.md#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(); - } -} -``` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | -| `A` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `findOptions` | [`SavedObjectsCreatePointInTimeFinderOptions`](../modules/client._internal_namespace.md#savedobjectscreatepointintimefinderoptions) | -| `dependencies?` | [`SavedObjectsCreatePointInTimeFinderDependencies`](../interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md) | - -#### Returns - -[`ISavedObjectsPointInTimeFinder`](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md)<`T`, `A`\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:534 - -___ - -### delete - -▸ **delete**(`type`, `id`, `options?`): `Promise`<{}\> - -Deletes a SavedObject - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `options?` | [`SavedObjectsDeleteOptions`](../interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md) | - -#### Returns - -`Promise`<{}\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:402 - -___ - -### find - -▸ **find**<`T`, `A`\>(`options`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>\> - -Find all SavedObjects matching the search query - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | -| `A` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`SavedObjectsFindOptions`](../interfaces/client._internal_namespace.SavedObjectsFindOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:408 - -___ - -### get - -▸ **get**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -Retrieves a single object - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | `string` | The type of SavedObject to retrieve | -| `id` | `string` | The ID of the SavedObject to retrieve | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:428 - -___ - -### openPointInTimeForType - -▸ **openPointInTimeForType**(`type`, `options?`): `Promise`<[`SavedObjectsOpenPointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md)\> - -Opens a Point In Time (PIT) against the indices for the specified Saved Object types. -The returned `id` can then be passed to [SavedObjectsClient.find](client._internal_namespace.SavedObjectsClient.md#find) to search -against that PIT. - -Only use this API if you have an advanced use case that's not solved by the -[SavedObjectsClient.createPointInTimeFinder](client._internal_namespace.SavedObjectsClient.md#createpointintimefinder) method. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` \| `string`[] | -| `options?` | [`SavedObjectsOpenPointInTimeOptions`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsOpenPointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:479 - -___ - -### removeReferencesTo - -▸ **removeReferencesTo**(`type`, `id`, `options?`): `Promise`<[`SavedObjectsRemoveReferencesToResponse`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md)\> - -Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `options?` | [`SavedObjectsRemoveReferencesToOptions`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsRemoveReferencesToResponse`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:470 - -___ - -### resolve - -▸ **resolve**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>\> - -Resolves a single object, using any legacy URL alias if it exists - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | `string` | The type of SavedObject to retrieve | -| `id` | `string` | The ID of the SavedObject to retrieve | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | | - -#### Returns - -`Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:452 - -___ - -### update - -▸ **update**<`T`\>(`type`, `id`, `attributes`, `options?`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>\> - -Updates an SavedObject - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `attributes` | `Partial`<`T`\> | -| `options?` | [`SavedObjectsUpdateOptions`](../interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md)<`T`\> | - -#### Returns - -`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:460 - -___ - -### updateObjectsSpaces - -▸ **updateObjectsSpaces**(`objects`, `spacesToAdd`, `spacesToRemove`, `options?`): `Promise`<[`SavedObjectsUpdateObjectsSpacesResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md)\> - -Updates one or more objects to add and/or remove them from specified spaces. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `objects` | [`SavedObjectsUpdateObjectsSpacesObject`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md)[] | -| `spacesToAdd` | `string`[] | -| `spacesToRemove` | `string`[] | -| `options?` | [`SavedObjectsUpdateObjectsSpacesOptions`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsUpdateObjectsSpacesResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:550 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsErrorHelpers.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsErrorHelpers.md deleted file mode 100644 index c428ccb237f1bd..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsErrorHelpers.md +++ /dev/null @@ -1,665 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsErrorHelpers - -# Class: SavedObjectsErrorHelpers - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsErrorHelpers - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.SavedObjectsErrorHelpers.md#constructor) - -### Methods - -- [createBadRequestError](client._internal_namespace.SavedObjectsErrorHelpers.md#createbadrequesterror) -- [createConflictError](client._internal_namespace.SavedObjectsErrorHelpers.md#createconflicterror) -- [createGenericNotFoundError](client._internal_namespace.SavedObjectsErrorHelpers.md#creategenericnotfounderror) -- [createGenericNotFoundEsUnavailableError](client._internal_namespace.SavedObjectsErrorHelpers.md#creategenericnotfoundesunavailableerror) -- [createIndexAliasNotFoundError](client._internal_namespace.SavedObjectsErrorHelpers.md#createindexaliasnotfounderror) -- [createInvalidVersionError](client._internal_namespace.SavedObjectsErrorHelpers.md#createinvalidversionerror) -- [createTooManyRequestsError](client._internal_namespace.SavedObjectsErrorHelpers.md#createtoomanyrequestserror) -- [createUnsupportedTypeError](client._internal_namespace.SavedObjectsErrorHelpers.md#createunsupportedtypeerror) -- [decorateBadRequestError](client._internal_namespace.SavedObjectsErrorHelpers.md#decoratebadrequesterror) -- [decorateConflictError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateconflicterror) -- [decorateEsCannotExecuteScriptError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateescannotexecutescripterror) -- [decorateEsUnavailableError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateesunavailableerror) -- [decorateForbiddenError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateforbiddenerror) -- [decorateGeneralError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorategeneralerror) -- [decorateIndexAliasNotFoundError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateindexaliasnotfounderror) -- [decorateNotAuthorizedError](client._internal_namespace.SavedObjectsErrorHelpers.md#decoratenotauthorizederror) -- [decorateRequestEntityTooLargeError](client._internal_namespace.SavedObjectsErrorHelpers.md#decoraterequestentitytoolargeerror) -- [decorateTooManyRequestsError](client._internal_namespace.SavedObjectsErrorHelpers.md#decoratetoomanyrequestserror) -- [isBadRequestError](client._internal_namespace.SavedObjectsErrorHelpers.md#isbadrequesterror) -- [isConflictError](client._internal_namespace.SavedObjectsErrorHelpers.md#isconflicterror) -- [isEsCannotExecuteScriptError](client._internal_namespace.SavedObjectsErrorHelpers.md#isescannotexecutescripterror) -- [isEsUnavailableError](client._internal_namespace.SavedObjectsErrorHelpers.md#isesunavailableerror) -- [isForbiddenError](client._internal_namespace.SavedObjectsErrorHelpers.md#isforbiddenerror) -- [isGeneralError](client._internal_namespace.SavedObjectsErrorHelpers.md#isgeneralerror) -- [isInvalidVersionError](client._internal_namespace.SavedObjectsErrorHelpers.md#isinvalidversionerror) -- [isNotAuthorizedError](client._internal_namespace.SavedObjectsErrorHelpers.md#isnotauthorizederror) -- [isNotFoundError](client._internal_namespace.SavedObjectsErrorHelpers.md#isnotfounderror) -- [isRequestEntityTooLargeError](client._internal_namespace.SavedObjectsErrorHelpers.md#isrequestentitytoolargeerror) -- [isSavedObjectsClientError](client._internal_namespace.SavedObjectsErrorHelpers.md#issavedobjectsclienterror) -- [isTooManyRequestsError](client._internal_namespace.SavedObjectsErrorHelpers.md#istoomanyrequestserror) - -## Constructors - -### constructor - -• **new SavedObjectsErrorHelpers**() - -## Methods - -### createBadRequestError - -▸ `Static` **createBadRequestError**(`reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:12 - -___ - -### createConflictError - -▸ `Static` **createConflictError**(`type`, `id`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:28 - -___ - -### createGenericNotFoundError - -▸ `Static` **createGenericNotFoundError**(`type?`, `id?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type?` | ``null`` \| `string` | -| `id?` | ``null`` \| `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:23 - -___ - -### createGenericNotFoundEsUnavailableError - -▸ `Static` **createGenericNotFoundEsUnavailableError**(`type?`, `id?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type?` | ``null`` \| `string` | -| `id?` | ``null`` \| `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:39 - -___ - -### createIndexAliasNotFoundError - -▸ `Static` **createIndexAliasNotFoundError**(`alias`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `alias` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:24 - -___ - -### createInvalidVersionError - -▸ `Static` **createInvalidVersionError**(`versionInput?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionInput?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:15 - -___ - -### createTooManyRequestsError - -▸ `Static` **createTooManyRequestsError**(`type`, `id`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:31 - -___ - -### createUnsupportedTypeError - -▸ `Static` **createUnsupportedTypeError**(`type`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:13 - -___ - -### decorateBadRequestError - -▸ `Static` **decorateBadRequestError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:11 - -___ - -### decorateConflictError - -▸ `Static` **decorateConflictError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:27 - -___ - -### decorateEsCannotExecuteScriptError - -▸ `Static` **decorateEsCannotExecuteScriptError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:33 - -___ - -### decorateEsUnavailableError - -▸ `Static` **decorateEsUnavailableError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:35 - -___ - -### decorateForbiddenError - -▸ `Static` **decorateForbiddenError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:19 - -___ - -### decorateGeneralError - -▸ `Static` **decorateGeneralError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:37 - -___ - -### decorateIndexAliasNotFoundError - -▸ `Static` **decorateIndexAliasNotFoundError**(`error`, `alias`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `alias` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:25 - -___ - -### decorateNotAuthorizedError - -▸ `Static` **decorateNotAuthorizedError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:17 - -___ - -### decorateRequestEntityTooLargeError - -▸ `Static` **decorateRequestEntityTooLargeError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:21 - -___ - -### decorateTooManyRequestsError - -▸ `Static` **decorateTooManyRequestsError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `reason?` | `string` | - -#### Returns - -[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:30 - -___ - -### isBadRequestError - -▸ `Static` **isBadRequestError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:14 - -___ - -### isConflictError - -▸ `Static` **isConflictError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:29 - -___ - -### isEsCannotExecuteScriptError - -▸ `Static` **isEsCannotExecuteScriptError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:34 - -___ - -### isEsUnavailableError - -▸ `Static` **isEsUnavailableError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:36 - -___ - -### isForbiddenError - -▸ `Static` **isForbiddenError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:20 - -___ - -### isGeneralError - -▸ `Static` **isGeneralError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:38 - -___ - -### isInvalidVersionError - -▸ `Static` **isInvalidVersionError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:16 - -___ - -### isNotAuthorizedError - -▸ `Static` **isNotAuthorizedError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:18 - -___ - -### isNotFoundError - -▸ `Static` **isNotFoundError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:26 - -___ - -### isRequestEntityTooLargeError - -▸ `Static` **isRequestEntityTooLargeError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:22 - -___ - -### isSavedObjectsClientError - -▸ `Static` **isSavedObjectsClientError**(`error`): error is DecoratedError - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `any` | - -#### Returns - -error is DecoratedError - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:10 - -___ - -### isTooManyRequestsError - -▸ `Static` **isTooManyRequestsError**(`error`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | - -#### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:32 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsRepository.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsRepository.md deleted file mode 100644 index 967fa67b356406..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsRepository.md +++ /dev/null @@ -1,1082 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsRepository - -# Class: SavedObjectsRepository - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsRepository - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.SavedObjectsRepository.md#constructor) - -### Properties - -- [\_allowedTypes](client._internal_namespace.SavedObjectsRepository.md#_allowedtypes) -- [\_index](client._internal_namespace.SavedObjectsRepository.md#_index) -- [\_logger](client._internal_namespace.SavedObjectsRepository.md#_logger) -- [\_mappings](client._internal_namespace.SavedObjectsRepository.md#_mappings) -- [\_migrator](client._internal_namespace.SavedObjectsRepository.md#_migrator) -- [\_rawToSavedObject](client._internal_namespace.SavedObjectsRepository.md#_rawtosavedobject) -- [\_registry](client._internal_namespace.SavedObjectsRepository.md#_registry) -- [\_serializer](client._internal_namespace.SavedObjectsRepository.md#_serializer) -- [client](client._internal_namespace.SavedObjectsRepository.md#client) -- [getIndexForType](client._internal_namespace.SavedObjectsRepository.md#getindexfortype) -- [getIndicesForTypes](client._internal_namespace.SavedObjectsRepository.md#getindicesfortypes) -- [incrementCounterInternal](client._internal_namespace.SavedObjectsRepository.md#incrementcounterinternal) -- [preflightCheckForUpsertAliasConflict](client._internal_namespace.SavedObjectsRepository.md#preflightcheckforupsertaliasconflict) -- [preflightCheckNamespaces](client._internal_namespace.SavedObjectsRepository.md#preflightchecknamespaces) -- [rawDocExistsInNamespace](client._internal_namespace.SavedObjectsRepository.md#rawdocexistsinnamespace) -- [rawDocExistsInNamespaces](client._internal_namespace.SavedObjectsRepository.md#rawdocexistsinnamespaces) -- [validateInitialNamespaces](client._internal_namespace.SavedObjectsRepository.md#validateinitialnamespaces) -- [validateObjectAttributes](client._internal_namespace.SavedObjectsRepository.md#validateobjectattributes) -- [validateObjectNamespaces](client._internal_namespace.SavedObjectsRepository.md#validateobjectnamespaces) - -### Methods - -- [bulkCreate](client._internal_namespace.SavedObjectsRepository.md#bulkcreate) -- [bulkGet](client._internal_namespace.SavedObjectsRepository.md#bulkget) -- [bulkResolve](client._internal_namespace.SavedObjectsRepository.md#bulkresolve) -- [bulkUpdate](client._internal_namespace.SavedObjectsRepository.md#bulkupdate) -- [checkConflicts](client._internal_namespace.SavedObjectsRepository.md#checkconflicts) -- [closePointInTime](client._internal_namespace.SavedObjectsRepository.md#closepointintime) -- [collectMultiNamespaceReferences](client._internal_namespace.SavedObjectsRepository.md#collectmultinamespacereferences) -- [create](client._internal_namespace.SavedObjectsRepository.md#create) -- [createPointInTimeFinder](client._internal_namespace.SavedObjectsRepository.md#createpointintimefinder) -- [delete](client._internal_namespace.SavedObjectsRepository.md#delete) -- [deleteByNamespace](client._internal_namespace.SavedObjectsRepository.md#deletebynamespace) -- [find](client._internal_namespace.SavedObjectsRepository.md#find) -- [get](client._internal_namespace.SavedObjectsRepository.md#get) -- [incrementCounter](client._internal_namespace.SavedObjectsRepository.md#incrementcounter) -- [openPointInTimeForType](client._internal_namespace.SavedObjectsRepository.md#openpointintimefortype) -- [removeReferencesTo](client._internal_namespace.SavedObjectsRepository.md#removereferencesto) -- [resolve](client._internal_namespace.SavedObjectsRepository.md#resolve) -- [update](client._internal_namespace.SavedObjectsRepository.md#update) -- [updateObjectsSpaces](client._internal_namespace.SavedObjectsRepository.md#updateobjectsspaces) -- [createRepository](client._internal_namespace.SavedObjectsRepository.md#createrepository) - -## Constructors - -### constructor - -• `Private` **new SavedObjectsRepository**() - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:88 - -## Properties - -### \_allowedTypes - -• `Private` **\_allowedTypes**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:75 - -___ - -### \_index - -• `Private` **\_index**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:72 - -___ - -### \_logger - -• `Private` **\_logger**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:78 - -___ - -### \_mappings - -• `Private` **\_mappings**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:73 - -___ - -### \_migrator - -• `Private` **\_migrator**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:71 - -___ - -### \_rawToSavedObject - -• `Private` **\_rawToSavedObject**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:445 - -___ - -### \_registry - -• `Private` **\_registry**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:74 - -___ - -### \_serializer - -• `Private` **\_serializer**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:77 - -___ - -### client - -• `Private` `Readonly` **client**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:76 - -___ - -### getIndexForType - -• `Private` **getIndexForType**: `any` - -Returns index specified by the given type or the default index - -**`param`** the type - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:436 - -___ - -### getIndicesForTypes - -• `Private` **getIndicesForTypes**: `any` - -Returns an array of indices as specified in `this._registry` for each of the -given `types`. If any of the types don't have an associated index, the -default index `this._index` will be included. - -**`param`** The types whose indices should be retrieved - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:444 - -___ - -### incrementCounterInternal - -• `Private` **incrementCounterInternal**: `any` - -**`internal`** incrementCounter function that is used internally and bypasses validation checks. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:305 - -___ - -### preflightCheckForUpsertAliasConflict - -• `Private` **preflightCheckForUpsertAliasConflict**: `any` - -Pre-flight check to ensure that an upsert which would create a new object does not result in an alias conflict. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:455 - -___ - -### preflightCheckNamespaces - -• `Private` **preflightCheckNamespaces**: `any` - -Pre-flight check to ensure that a multi-namespace object exists in the current namespace. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:451 - -___ - -### rawDocExistsInNamespace - -• `Private` **rawDocExistsInNamespace**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:447 - -___ - -### rawDocExistsInNamespaces - -• `Private` **rawDocExistsInNamespaces**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:446 - -___ - -### validateInitialNamespaces - -• `Private` **validateInitialNamespaces**: `any` - -The `initialNamespaces` field (create, bulkCreate) is used to create an object in an initial set of spaces. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:457 - -___ - -### validateObjectAttributes - -• `Private` **validateObjectAttributes**: `any` - -Validate a migrated doc against the registered saved object type's schema. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:461 - -___ - -### validateObjectNamespaces - -• `Private` **validateObjectNamespaces**: `any` - -The object-specific `namespaces` field (bulkGet) is used to check if an object exists in any of a given number of spaces. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:459 - -## Methods - -### bulkCreate - -▸ **bulkCreate**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> - -Creates multiple documents at once - -**`property`** {boolean} [options.overwrite=false] - overwrites existing documents - -**`property`** {string} [options.namespace] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objects` | [`SavedObjectsBulkCreateObject`](../interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md)<`T`\>[] | [{ type, id, attributes, references, migrationVersion }] | -| `options?` | [`SavedObjectsCreateOptions`](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) | - | - -#### Returns - -`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> - -- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]} - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:112 - -___ - -### bulkGet - -▸ **bulkGet**<`T`\>(`objects?`, `options?`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> - -Returns an array of objects by id - -**`property`** {string} [options.namespace] - -**`example`** - -bulkGet([ - { id: 'one', type: 'config' }, - { id: 'foo', type: 'index-pattern' } -]) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objects?` | [`SavedObjectsBulkGetObject`](../interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md)[] | an array of objects containing id, type and optionally fields | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - | - -#### Returns - -`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> - -- { saved_objects: [{ id, type, version, attributes }] } - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:169 - -___ - -### bulkResolve - -▸ **bulkResolve**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md)<`T`\>\> - -Resolves an array of objects by id, using any legacy URL aliases if they exist - -**`property`** {string} [options.namespace] - -**`example`** - -bulkResolve([ - { id: 'one', type: 'config' }, - { id: 'foo', type: 'index-pattern' } -]) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objects` | [`SavedObjectsBulkResolveObject`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md)[] | an array of objects containing id, type | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - | - -#### Returns - -`Promise`<[`SavedObjectsBulkResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md)<`T`\>\> - -- { resolved_objects: [{ saved_object, outcome }] } - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:184 - -___ - -### bulkUpdate - -▸ **bulkUpdate**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<`T`\>\> - -Updates multiple objects in bulk - -**`property`** {string} options.version - ensures version matches that of persisted object - -**`property`** {string} [options.namespace] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objects` | [`SavedObjectsBulkUpdateObject`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md)<`T`\>[] | [{ type, id, attributes, options: { version, namespace } references }] | -| `options?` | [`SavedObjectsBulkUpdateOptions`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md) | - | - -#### Returns - -`Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<`T`\>\> - -- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]} - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:241 - -___ - -### checkConflicts - -▸ **checkConflicts**(`objects?`, `options?`): `Promise`<[`SavedObjectsCheckConflictsResponse`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md)\> - -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. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `objects?` | [`SavedObjectsCheckConflictsObject`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md)[] | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsCheckConflictsResponse`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:117 - -___ - -### closePointInTime - -▸ **closePointInTime**(`id`, `options?`): `Promise`<[`SavedObjectsClosePointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md)\> - -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 -[SavedObjectsRepository.createPointInTimeFinder](client._internal_namespace.SavedObjectsRepository.md#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); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsClosePointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md)\> - -- [SavedObjectsClosePointInTimeResponse](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:384 - -___ - -### collectMultiNamespaceReferences - -▸ **collectMultiNamespaceReferences**(`objects`, `options?`): `Promise`<[`SavedObjectsCollectMultiNamespaceReferencesResponse`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md)\> - -Gets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace -type. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objects` | [`SavedObjectsCollectMultiNamespaceReferencesObject`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md)[] | The objects to get the references for. | -| `options?` | [`SavedObjectsCollectMultiNamespaceReferencesOptions`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md) | - | - -#### Returns - -`Promise`<[`SavedObjectsCollectMultiNamespaceReferencesResponse`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:223 - -___ - -### create - -▸ **create**<`T`\>(`type`, `attributes`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -Persists an object - -**`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 }] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `attributes` | `T` | -| `options?` | [`SavedObjectsCreateOptions`](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -- { id, type, version, attributes } - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:102 - -___ - -### createPointInTimeFinder - -▸ **createPointInTimeFinder**<`T`, `A`\>(`findOptions`, `dependencies?`): [`ISavedObjectsPointInTimeFinder`](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md)<`T`, `A`\> - -Returns a [ISavedObjectsPointInTimeFinder](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md) 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 [SavedObjectsRepository.find](client._internal_namespace.SavedObjectsRepository.md#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(); - } -} -``` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | -| `A` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `findOptions` | [`SavedObjectsCreatePointInTimeFinderOptions`](../modules/client._internal_namespace.md#savedobjectscreatepointintimefinderoptions) | -| `dependencies?` | [`SavedObjectsCreatePointInTimeFinderDependencies`](../interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md) | - -#### Returns - -[`ISavedObjectsPointInTimeFinder`](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md)<`T`, `A`\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:430 - -___ - -### delete - -▸ **delete**(`type`, `id`, `options?`): `Promise`<{}\> - -Deletes an object - -**`property`** {string} [options.namespace] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `options?` | [`SavedObjectsDeleteOptions`](../interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md) | - -#### Returns - -`Promise`<{}\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:127 - -___ - -### deleteByNamespace - -▸ **deleteByNamespace**(`namespace`, `options?`): `Promise`<`any`\> - -Deletes all objects from the provided namespace. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | -| `options?` | [`SavedObjectsDeleteByNamespaceOptions`](../interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md) | - -#### Returns - -`Promise`<`any`\> - -- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures } - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:134 - -___ - -### find - -▸ **find**<`T`, `A`\>(`options`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>\> - -**`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] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | -| `A` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`SavedObjectsFindOptions`](../interfaces/client._internal_namespace.SavedObjectsFindOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>\> - -- { saved_objects: [{ id, type, version, attributes }], total, per_page, page } - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:154 - -___ - -### get - -▸ **get**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -Gets a single object - -**`property`** {string} [options.namespace] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -- { id, type, version, attributes } - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:194 - -___ - -### incrementCounter - -▸ **incrementCounter**<`T`\>(`type`, `id`, `counterFields`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -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' } } -) -``` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | `string` | The type of saved object whose fields should be incremented | -| `id` | `string` | The id of the document whose fields should be incremented | -| `counterFields` | (`string` \| [`SavedObjectsIncrementCounterField`](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md))[] | An array of field names to increment or an array of [SavedObjectsIncrementCounterField](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md) | -| `options?` | [`SavedObjectsIncrementCounterOptions`](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md)<`T`\> | [SavedObjectsIncrementCounterOptions](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md) | - -#### Returns - -`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> - -The saved object after the specified fields were incremented - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:303 - -___ - -### openPointInTimeForType - -▸ **openPointInTimeForType**(`type`, `[options]?`): `Promise`<[`SavedObjectsOpenPointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md)\> - -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 -[SavedObjectsRepository.createPointInTimeFinder](client._internal_namespace.SavedObjectsRepository.md#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); -``` - -**`property`** {string} [options.keepAlive] - -**`property`** {string} [options.preference] - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | `string` \| `string`[] | | -| `[options]?` | [`SavedObjectsOpenPointInTimeOptions`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md) | [SavedObjectsOpenPointInTimeOptions](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsOpenPointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md)\> - -- { id: string } - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:342 - -___ - -### removeReferencesTo - -▸ **removeReferencesTo**(`type`, `id`, `options?`): `Promise`<[`SavedObjectsRemoveReferencesToResponse`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md)\> - -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. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `options?` | [`SavedObjectsRemoveReferencesToOptions`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsRemoveReferencesToResponse`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:249 - -___ - -### resolve - -▸ **resolve**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>\> - -Resolves a single object, using any legacy URL alias if it exists - -**`property`** {string} [options.namespace] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>\> - -- { saved_object, outcome } - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:204 - -___ - -### update - -▸ **update**<`T`\>(`type`, `id`, `attributes`, `options?`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>\> - -Updates an object - -**`property`** {string} options.version - ensures version matches that of persisted object - -**`property`** {string} [options.namespace] - -**`property`** {array} [options.references] - [{ name, type, id }] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `attributes` | `Partial`<`T`\> | -| `options?` | [`SavedObjectsUpdateOptions`](../interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md)<`T`\> | - -#### Returns - -`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:216 - -___ - -### updateObjectsSpaces - -▸ **updateObjectsSpaces**(`objects`, `spacesToAdd`, `spacesToRemove`, `options?`): `Promise`<[`SavedObjectsUpdateObjectsSpacesResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md)\> - -Updates one or more objects to add and/or remove them from specified spaces. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `objects` | [`SavedObjectsUpdateObjectsSpacesObject`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md)[] | -| `spacesToAdd` | `string`[] | -| `spacesToRemove` | `string`[] | -| `options?` | [`SavedObjectsUpdateObjectsSpacesOptions`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md) | - -#### Returns - -`Promise`<[`SavedObjectsUpdateObjectsSpacesResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:232 - -___ - -### createRepository - -▸ `Static` **createRepository**(`migrator`, `typeRegistry`, `indexName`, `client`, `logger`, `includedHiddenTypes?`, `injectedConstructor?`): [`ISavedObjectsRepository`](../modules/client._internal_namespace.md#isavedobjectsrepository) - -A factory function for creating SavedObjectRepository instances. - -**`internalremarks`** -Tests are located in ./repository_create_repository.test.ts - -**`internal`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `migrator` | [`IKibanaMigrator`](../modules/client._internal_namespace.md#ikibanamigrator) | -| `typeRegistry` | [`ISavedObjectTypeRegistry`](../modules/client._internal_namespace.md#isavedobjecttyperegistry) | -| `indexName` | `string` | -| `client` | [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) | -| `logger` | `Logger` | -| `includedHiddenTypes?` | `string`[] | -| `injectedConstructor?` | `any` | - -#### Returns - -[`ISavedObjectsRepository`](../modules/client._internal_namespace.md#isavedobjectsrepository) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:87 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SpaceActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SpaceActions.md deleted file mode 100644 index b39329e27b8ba3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SpaceActions.md +++ /dev/null @@ -1,59 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SpaceActions - -# Class: SpaceActions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SpaceActions - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.SpaceActions.md#constructor) - -### Properties - -- [prefix](client._internal_namespace.SpaceActions.md#prefix) - -### Accessors - -- [manage](client._internal_namespace.SpaceActions.md#manage) - -## Constructors - -### constructor - -• **new SpaceActions**(`versionNumber`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionNumber` | `string` | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/space.d.ts:3 - -## Properties - -### prefix - -• `Private` `Readonly` **prefix**: `any` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/space.d.ts:2 - -## Accessors - -### manage - -• `get` **manage**(): `string` - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/space.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SubFeature.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SubFeature.md deleted file mode 100644 index 4e300b22312858..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SubFeature.md +++ /dev/null @@ -1,97 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SubFeature - -# Class: SubFeature - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SubFeature - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.SubFeature.md#constructor) - -### Properties - -- [config](client._internal_namespace.SubFeature.md#config) - -### Accessors - -- [name](client._internal_namespace.SubFeature.md#name) -- [privilegeGroups](client._internal_namespace.SubFeature.md#privilegegroups) - -### Methods - -- [toRaw](client._internal_namespace.SubFeature.md#toraw) - -## Constructors - -### constructor - -• **new SubFeature**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `Readonly`<{ `name`: `string` ; `privilegeGroups`: readonly `Readonly`<{ groupType: SubFeaturePrivilegeGroupType; privileges: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| ... 4 more ... \| undefined; ... 9 more ...; ui: readonly string[]; }\>[]; }\>[] }\> | - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:66 - -## Properties - -### config - -• `Protected` `Readonly` **config**: `Readonly`<{ `name`: `string` ; `privilegeGroups`: readonly `Readonly`<{ groupType: SubFeaturePrivilegeGroupType; privileges: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| ... 4 more ... \| undefined; ... 9 more ...; ui: readonly string[]; }\>[]; }\>[] }\> - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:65 - -## Accessors - -### name - -• `get` **name**(): `string` - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:67 - -___ - -### privilegeGroups - -• `get` **privilegeGroups**(): readonly `Readonly`<{ `groupType`: [`SubFeaturePrivilegeGroupType`](../modules/client._internal_namespace.md#subfeatureprivilegegrouptype) ; `privileges`: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| "gold" \| "platinum" \| "enterprise" \| "trial" \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 8 more ...; savedObject: Readonly<...\>; }\>[] }\>[] - -#### Returns - -readonly `Readonly`<{ `groupType`: [`SubFeaturePrivilegeGroupType`](../modules/client._internal_namespace.md#subfeatureprivilegegrouptype) ; `privileges`: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| "gold" \| "platinum" \| "enterprise" \| "trial" \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 8 more ...; savedObject: Readonly<...\>; }\>[] }\>[] - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:68 - -## Methods - -### toRaw - -▸ **toRaw**(): `Object` - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `privilegeGroups` | readonly `Readonly`<{ `groupType`: [`SubFeaturePrivilegeGroupType`](../modules/client._internal_namespace.md#subfeatureprivilegegrouptype) ; `privileges`: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| "gold" \| "platinum" \| "enterprise" \| "trial" \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 8 more ...; savedObject: Readonly<...\>; }\>[] }\>[] | - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:104 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.TaskRunnerFactory.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.TaskRunnerFactory.md deleted file mode 100644 index 7aed74f96c6985..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.TaskRunnerFactory.md +++ /dev/null @@ -1,114 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskRunnerFactory - -# Class: TaskRunnerFactory - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskRunnerFactory - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.TaskRunnerFactory.md#constructor) - -### Properties - -- [actionExecutor](client._internal_namespace.TaskRunnerFactory.md#actionexecutor) -- [isInitialized](client._internal_namespace.TaskRunnerFactory.md#isinitialized) -- [taskRunnerContext](client._internal_namespace.TaskRunnerFactory.md#taskrunnercontext) - -### Methods - -- [create](client._internal_namespace.TaskRunnerFactory.md#create) -- [initialize](client._internal_namespace.TaskRunnerFactory.md#initialize) - -## Constructors - -### constructor - -• **new TaskRunnerFactory**(`actionExecutor`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionExecutor` | [`ActionExecutorContract`](../modules/client._internal_namespace.md#actionexecutorcontract) | - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:18 - -## Properties - -### actionExecutor - -• `Private` `Readonly` **actionExecutor**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:17 - -___ - -### isInitialized - -• `Private` **isInitialized**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:15 - -___ - -### taskRunnerContext - -• `Private` `Optional` **taskRunnerContext**: `any` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:16 - -## Methods - -### create - -▸ **create**(`__namedParameters`, `maxAttempts?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`RunContext`](../interfaces/client._internal_namespace.RunContext.md) | -| `maxAttempts?` | `number` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `cancel` | () => `Promise`<{ `state`: {} }\> | -| `run` | () => `Promise`<`void`\> | - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:20 - -___ - -### initialize - -▸ **initialize**(`taskRunnerContext`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `taskRunnerContext` | [`TaskRunnerContext`](../interfaces/client._internal_namespace.TaskRunnerContext.md) | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:19 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UIActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UIActions.md deleted file mode 100644 index 8f74b5fff8806d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UIActions.md +++ /dev/null @@ -1,66 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UIActions - -# Class: UIActions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UIActions - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.UIActions.md#constructor) - -### Properties - -- [prefix](client._internal_namespace.UIActions.md#prefix) - -### Methods - -- [get](client._internal_namespace.UIActions.md#get) - -## Constructors - -### constructor - -• **new UIActions**(`versionNumber`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionNumber` | `string` | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/ui.d.ts:4 - -## Properties - -### prefix - -• `Private` `Readonly` **prefix**: `any` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/ui.d.ts:3 - -## Methods - -### get - -▸ **get**(`featureId`, ...`uiCapabilityParts`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `featureId` | keyof [`Capabilities`](../interfaces/client._internal_namespace.Capabilities.md) | -| `...uiCapabilityParts` | `string`[] | - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/actions/ui.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UserActionBuilder.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UserActionBuilder.md deleted file mode 100644 index 361d5e50fd923e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UserActionBuilder.md +++ /dev/null @@ -1,251 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UserActionBuilder - -# Class: UserActionBuilder - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UserActionBuilder - -## Table of contents - -### Constructors - -- [constructor](client._internal_namespace.UserActionBuilder.md#constructor) - -### Methods - -- [build](client._internal_namespace.UserActionBuilder.md#build) -- [buildCommonUserAction](client._internal_namespace.UserActionBuilder.md#buildcommonuseraction) -- [createActionReference](client._internal_namespace.UserActionBuilder.md#createactionreference) -- [createCaseReferences](client._internal_namespace.UserActionBuilder.md#createcasereferences) -- [createCommentReferences](client._internal_namespace.UserActionBuilder.md#createcommentreferences) -- [createConnectorPushReference](client._internal_namespace.UserActionBuilder.md#createconnectorpushreference) -- [createConnectorReference](client._internal_namespace.UserActionBuilder.md#createconnectorreference) -- [extractConnectorId](client._internal_namespace.UserActionBuilder.md#extractconnectorid) -- [extractConnectorIdFromExternalService](client._internal_namespace.UserActionBuilder.md#extractconnectoridfromexternalservice) -- [getCommonUserActionAttributes](client._internal_namespace.UserActionBuilder.md#getcommonuseractionattributes) - -## Constructors - -### constructor - -• **new UserActionBuilder**() - -## Methods - -### build - -▸ `Abstract` **build**<`T`\>(`args`): [`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends keyof [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | [`UserActionParameters`](../modules/client._internal_namespace.md#useractionparameters)<`T`\> | - -#### Returns - -[`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md) - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:119](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L119) - -___ - -### buildCommonUserAction - -▸ `Protected` **buildCommonUserAction**(`__namedParameters`): [`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CommonBuilderArguments`](../modules/client._internal_namespace.md#commonbuilderarguments) | - -#### Returns - -[`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md) - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:88](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L88) - -___ - -### createActionReference - -▸ `Protected` **createActionReference**(`id`, `name`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | ``null`` \| `string` | -| `name` | `string` | - -#### Returns - -[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:55](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L55) - -___ - -### createCaseReferences - -▸ `Protected` **createCaseReferences**(`caseId`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `caseId` | `string` | - -#### Returns - -[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:45](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L45) - -___ - -### createCommentReferences - -▸ `Protected` **createCommentReferences**(`id`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | ``null`` \| `string` | - -#### Returns - -[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:61](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L61) - -___ - -### createConnectorPushReference - -▸ `Protected` **createConnectorPushReference**(`id`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | ``null`` \| `string` | - -#### Returns - -[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L77) - -___ - -### createConnectorReference - -▸ `Protected` **createConnectorReference**(`id`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | ``null`` \| `string` | - -#### Returns - -[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:73](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L73) - -___ - -### extractConnectorId - -▸ `Protected` **extractConnectorId**(`connector`): `Omit`<{ `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string }, ``"id"``\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `connector` | { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } | - -#### Returns - -`Omit`<{ `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string }, ``"id"``\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:40](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L40) - -___ - -### extractConnectorIdFromExternalService - -▸ `Protected` **extractConnectorIdFromExternalService**(`externalService`): `Omit`<{ `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT }, ``"connector_id"``\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `externalService` | { `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT } | - -#### Returns - -`Omit`<{ `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT }, ``"connector_id"``\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:81](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L81) - -___ - -### getCommonUserActionAttributes - -▸ `Protected` **getCommonUserActionAttributes**(`__namedParameters`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.owner` | `string` | -| `__namedParameters.user` | `Object` | -| `__namedParameters.user.email` | `undefined` \| ``null`` \| `string` | -| `__namedParameters.user.full_name` | `undefined` \| ``null`` \| `string` | -| `__namedParameters.user.username` | `undefined` \| ``null`` \| `string` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `created_at` | `string` | -| `created_by` | `Object` | -| `created_by.email` | `undefined` \| ``null`` \| `string` | -| `created_by.full_name` | `undefined` \| ``null`` \| `string` | -| `created_by.username` | `undefined` \| ``null`` \| `string` | -| `owner` | `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:32](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L32) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client.casesclient.md b/x-pack/plugins/cases/docs/cases_client/classes/client.casesclient.md deleted file mode 100644 index d00f9f0edcd88d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/classes/client.casesclient.md +++ /dev/null @@ -1,214 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / CasesClient - -# Class: CasesClient - -[client](../modules/client.md).CasesClient - -Client wrapper that contains accessor methods for individual entities within the cases system. - -## Table of contents - -### Constructors - -- [constructor](client.CasesClient.md#constructor) - -### Properties - -- [\_attachments](client.CasesClient.md#_attachments) -- [\_cases](client.CasesClient.md#_cases) -- [\_casesClientInternal](client.CasesClient.md#_casesclientinternal) -- [\_configure](client.CasesClient.md#_configure) -- [\_metrics](client.CasesClient.md#_metrics) -- [\_stats](client.CasesClient.md#_stats) -- [\_userActions](client.CasesClient.md#_useractions) - -### Accessors - -- [attachments](client.CasesClient.md#attachments) -- [cases](client.CasesClient.md#cases) -- [configure](client.CasesClient.md#configure) -- [metrics](client.CasesClient.md#metrics) -- [stats](client.CasesClient.md#stats) -- [userActions](client.CasesClient.md#useractions) - -## Constructors - -### constructor - -• **new CasesClient**(`args`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L29) - -## Properties - -### \_attachments - -• `Private` `Readonly` **\_attachments**: [`AttachmentsSubClient`](../interfaces/attachments_client.AttachmentsSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:23](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L23) - -___ - -### \_cases - -• `Private` `Readonly` **\_cases**: [`CasesSubClient`](../interfaces/cases_client.CasesSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L22) - -___ - -### \_casesClientInternal - -• `Private` `Readonly` **\_casesClientInternal**: [`CasesClientInternal`](client._internal_namespace.CasesClientInternal.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:21](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L21) - -___ - -### \_configure - -• `Private` `Readonly` **\_configure**: [`ConfigureSubClient`](../interfaces/configure_client.ConfigureSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L25) - -___ - -### \_metrics - -• `Private` `Readonly` **\_metrics**: [`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:27](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L27) - -___ - -### \_stats - -• `Private` `Readonly` **\_stats**: [`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:26](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L26) - -___ - -### \_userActions - -• `Private` `Readonly` **\_userActions**: [`UserActionsSubClient`](../interfaces/user_actions_client.UserActionsSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:24](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L24) - -## Accessors - -### attachments - -• `get` **attachments**(): [`AttachmentsSubClient`](../interfaces/attachments_client.AttachmentsSubClient.md) - -Retrieves an interface for interacting with attachments (comments) entities. - -#### Returns - -[`AttachmentsSubClient`](../interfaces/attachments_client.AttachmentsSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:49](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L49) - -___ - -### cases - -• `get` **cases**(): [`CasesSubClient`](../interfaces/cases_client.CasesSubClient.md) - -Retrieves an interface for interacting with cases entities. - -#### Returns - -[`CasesSubClient`](../interfaces/cases_client.CasesSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:42](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L42) - -___ - -### configure - -• `get` **configure**(): [`ConfigureSubClient`](../interfaces/configure_client.ConfigureSubClient.md) - -Retrieves an interface for interacting with the configuration of external connectors for the plugin entities. - -#### Returns - -[`ConfigureSubClient`](../interfaces/configure_client.ConfigureSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:63](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L63) - -___ - -### metrics - -• `get` **metrics**(): [`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md) - -Retrieves an interface for retrieving metrics related to the cases entities. - -#### Returns - -[`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L77) - -___ - -### stats - -• `get` **stats**(): [`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md) - -Retrieves an interface for retrieving statistics related to the cases entities. - -#### Returns - -[`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:70](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L70) - -___ - -### userActions - -• `get` **userActions**(): [`UserActionsSubClient`](../interfaces/user_actions_client.UserActionsSubClient.md) - -Retrieves an interface for interacting with the user actions associated with the plugin entities. - -#### Returns - -[`UserActionsSubClient`](../interfaces/user_actions_client.UserActionsSubClient.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/client.ts:56](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L56) diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ActionExecutionSourceType.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ActionExecutionSourceType.md deleted file mode 100644 index 9d4fbc639a26cd..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ActionExecutionSourceType.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionExecutionSourceType - -# Enumeration: ActionExecutionSourceType - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionExecutionSourceType - -## Table of contents - -### Enumeration members - -- [HTTP\_REQUEST](client._internal_namespace.ActionExecutionSourceType.md#http_request) -- [SAVED\_OBJECT](client._internal_namespace.ActionExecutionSourceType.md#saved_object) - -## Enumeration members - -### HTTP\_REQUEST - -• **HTTP\_REQUEST** = `"HTTP_REQUEST"` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_execution_source.d.ts:4 - -___ - -### SAVED\_OBJECT - -• **SAVED\_OBJECT** = `"SAVED_OBJECT"` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_execution_source.d.ts:3 diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.AuthorizationMode.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.AuthorizationMode.md deleted file mode 100644 index f1dc071f463d6a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.AuthorizationMode.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthorizationMode - -# Enumeration: AuthorizationMode - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthorizationMode - -## Table of contents - -### Enumeration members - -- [Legacy](client._internal_namespace.AuthorizationMode.md#legacy) -- [RBAC](client._internal_namespace.AuthorizationMode.md#rbac) - -## Enumeration members - -### Legacy - -• **Legacy** = `0` - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/get_authorization_mode_by_source.d.ts:4 - -___ - -### RBAC - -• **RBAC** = `1` - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/get_authorization_mode_by_source.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.CaseStatuses.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.CaseStatuses.md deleted file mode 100644 index 48d5689a524002..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.CaseStatuses.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CaseStatuses - -# Enumeration: CaseStatuses - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CaseStatuses - -## Table of contents - -### Enumeration members - -- [closed](client._internal_namespace.CaseStatuses.md#closed) -- [in-progress](client._internal_namespace.CaseStatuses.md#in-progress) -- [open](client._internal_namespace.CaseStatuses.md#open) - -## Enumeration members - -### closed - -• **closed** = `"closed"` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/status.ts:13](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/status.ts#L13) - -___ - -### in-progress - -• **in-progress** = `"in-progress"` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/status.ts:12](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/status.ts#L12) - -___ - -### open - -• **open** = `"open"` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/status.ts:11](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/status.ts#L11) diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.TaskStatus.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.TaskStatus.md deleted file mode 100644 index a92a96681e137b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.TaskStatus.md +++ /dev/null @@ -1,65 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskStatus - -# Enumeration: TaskStatus - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskStatus - -## Table of contents - -### Enumeration members - -- [Claiming](client._internal_namespace.TaskStatus.md#claiming) -- [Failed](client._internal_namespace.TaskStatus.md#failed) -- [Idle](client._internal_namespace.TaskStatus.md#idle) -- [Running](client._internal_namespace.TaskStatus.md#running) -- [Unrecognized](client._internal_namespace.TaskStatus.md#unrecognized) - -## Enumeration members - -### Claiming - -• **Claiming** = `"claiming"` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:124 - -___ - -### Failed - -• **Failed** = `"failed"` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:126 - -___ - -### Idle - -• **Idle** = `"idle"` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:123 - -___ - -### Running - -• **Running** = `"running"` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:125 - -___ - -### Unrecognized - -• **Unrecognized** = `"unrecognized"` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:127 diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ViewMode.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ViewMode.md deleted file mode 100644 index c00d063ffc864c..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ViewMode.md +++ /dev/null @@ -1,54 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ViewMode - -# Enumeration: ViewMode - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ViewMode - -## Table of contents - -### Enumeration members - -- [EDIT](client._internal_namespace.ViewMode.md#edit) -- [PREVIEW](client._internal_namespace.ViewMode.md#preview) -- [PRINT](client._internal_namespace.ViewMode.md#print) -- [VIEW](client._internal_namespace.ViewMode.md#view) - -## Enumeration members - -### EDIT - -• **EDIT** = `"edit"` - -#### Defined in - -src/plugins/embeddable/target/types/common/types.d.ts:5 - -___ - -### PREVIEW - -• **PREVIEW** = `"preview"` - -#### Defined in - -src/plugins/embeddable/target/types/common/types.d.ts:6 - -___ - -### PRINT - -• **PRINT** = `"print"` - -#### Defined in - -src/plugins/embeddable/target/types/common/types.d.ts:7 - -___ - -### VIEW - -• **VIEW** = `"view"` - -#### Defined in - -src/plugins/embeddable/target/types/common/types.d.ts:8 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.AddArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.AddArgs.md deleted file mode 100644 index b1a96017c439bd..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.AddArgs.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / AddArgs - -# Interface: AddArgs - -[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).AddArgs - -The arguments needed for creating a new attachment to a case. - -## Table of contents - -### Properties - -- [caseId](attachments_client._internal_namespace.AddArgs.md#caseid) -- [comment](attachments_client._internal_namespace.AddArgs.md#comment) - -## Properties - -### caseId - -• **caseId**: `string` - -The case ID that this attachment will be associated with - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/add.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/add.ts#L77) - -___ - -### comment - -• **comment**: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } - -The attachment values. - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/add.ts:81](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/add.ts#L81) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteAllArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteAllArgs.md deleted file mode 100644 index d2f34ab040eb3f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteAllArgs.md +++ /dev/null @@ -1,25 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / DeleteAllArgs - -# Interface: DeleteAllArgs - -[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).DeleteAllArgs - -Parameters for deleting all comments of a case. - -## Table of contents - -### Properties - -- [caseID](attachments_client._internal_namespace.DeleteAllArgs.md#caseid) - -## Properties - -### caseID - -• **caseID**: `string` - -The case ID to delete all attachments for - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/delete.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/delete.ts#L25) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteArgs.md deleted file mode 100644 index 0bee9af6c4f241..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteArgs.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / DeleteArgs - -# Interface: DeleteArgs - -[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).DeleteArgs - -Parameters for deleting a single attachment of a case. - -## Table of contents - -### Properties - -- [attachmentID](attachments_client._internal_namespace.DeleteArgs.md#attachmentid) -- [caseID](attachments_client._internal_namespace.DeleteArgs.md#caseid) - -## Properties - -### attachmentID - -• **attachmentID**: `string` - -The attachment ID to delete - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/delete.ts:39](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/delete.ts#L39) - -___ - -### caseID - -• **caseID**: `string` - -The case ID to delete an attachment from - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/delete.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/delete.ts#L35) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.FindArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.FindArgs.md deleted file mode 100644 index 2fd5a356bc6f5c..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.FindArgs.md +++ /dev/null @@ -1,54 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / FindArgs - -# Interface: FindArgs - -[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).FindArgs - -Parameters for finding attachments of a case - -## Table of contents - -### Properties - -- [caseID](attachments_client._internal_namespace.FindArgs.md#caseid) -- [queryParams](attachments_client._internal_namespace.FindArgs.md#queryparams) - -## Properties - -### caseID - -• **caseID**: `string` - -The case ID for finding associated attachments - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/get.ts:42](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L42) - -___ - -### queryParams - -• `Optional` **queryParams**: `Object` - -Optional parameters for filtering the returned attachments - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `defaultSearchOperator` | `undefined` \| ``"AND"`` \| ``"OR"`` | -| `fields` | `undefined` \| `string`[] | -| `filter` | `undefined` \| `string` | -| `hasReference` | `undefined` \| { `id`: `string` = rt.string; `type`: `string` = rt.string } \| { `id`: `string` = rt.string; `type`: `string` = rt.string }[] | -| `hasReferenceOperator` | `undefined` \| ``"AND"`` \| ``"OR"`` | -| `page` | `undefined` \| `number` | -| `perPage` | `undefined` \| `number` | -| `search` | `undefined` \| `string` | -| `searchFields` | `undefined` \| `string`[] | -| `sortField` | `undefined` \| `string` | -| `sortOrder` | `undefined` \| ``"desc"`` \| ``"asc"`` | - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/get.ts:46](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L46) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md deleted file mode 100644 index d45019010a3d6e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md +++ /dev/null @@ -1,23 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / GetAllAlertsAttachToCase - -# Interface: GetAllAlertsAttachToCase - -[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).GetAllAlertsAttachToCase - -## Table of contents - -### Properties - -- [caseId](attachments_client._internal_namespace.GetAllAlertsAttachToCase.md#caseid) - -## Properties - -### caseId - -• **caseId**: `string` - -The ID of the case to retrieve the alerts from - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/get.ts:74](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L74) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllArgs.md deleted file mode 100644 index f5ebbd40a2d08e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllArgs.md +++ /dev/null @@ -1,25 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / GetAllArgs - -# Interface: GetAllArgs - -[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).GetAllArgs - -Parameters for retrieving all attachments of a case - -## Table of contents - -### Properties - -- [caseID](attachments_client._internal_namespace.GetAllArgs.md#caseid) - -## Properties - -### caseID - -• **caseID**: `string` - -The case ID to retrieve all attachments for - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/get.ts:56](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L56) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetArgs.md deleted file mode 100644 index 8c36ea3ab2f122..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetArgs.md +++ /dev/null @@ -1,36 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / GetArgs - -# Interface: GetArgs - -[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).GetArgs - -## Table of contents - -### Properties - -- [attachmentID](attachments_client._internal_namespace.GetArgs.md#attachmentid) -- [caseID](attachments_client._internal_namespace.GetArgs.md#caseid) - -## Properties - -### attachmentID - -• **attachmentID**: `string` - -The ID of the attachment to retrieve - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/get.ts:67](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L67) - -___ - -### caseID - -• **caseID**: `string` - -The ID of the case to retrieve an attachment from - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/get.ts:63](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L63) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.UpdateArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.UpdateArgs.md deleted file mode 100644 index 75650928ba1248..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.UpdateArgs.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / UpdateArgs - -# Interface: UpdateArgs - -[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).UpdateArgs - -Parameters for updating a single attachment - -## Table of contents - -### Properties - -- [caseID](attachments_client._internal_namespace.UpdateArgs.md#caseid) -- [updateRequest](attachments_client._internal_namespace.UpdateArgs.md#updaterequest) - -## Properties - -### caseID - -• **caseID**: `string` - -The ID of the case that is associated with this attachment - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/update.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/update.ts#L28) - -___ - -### updateRequest - -• **updateRequest**: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `id`: `string` = rt.string; `version`: `string` = rt.string } - -The full attachment request with the fields updated with appropriate values - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/update.ts:32](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/update.ts#L32) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client.attachmentssubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client.attachmentssubclient.md deleted file mode 100644 index 04b77c2141ed83..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client.attachmentssubclient.md +++ /dev/null @@ -1,198 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / AttachmentsSubClient - -# Interface: AttachmentsSubClient - -[attachments/client](../modules/attachments_client.md).AttachmentsSubClient - -API for interacting with the attachments to a case. - -## Table of contents - -### Methods - -- [add](attachments_client.AttachmentsSubClient.md#add) -- [delete](attachments_client.AttachmentsSubClient.md#delete) -- [deleteAll](attachments_client.AttachmentsSubClient.md#deleteall) -- [find](attachments_client.AttachmentsSubClient.md#find) -- [get](attachments_client.AttachmentsSubClient.md#get) -- [getAll](attachments_client.AttachmentsSubClient.md#getall) -- [getAllAlertsAttachToCase](attachments_client.AttachmentsSubClient.md#getallalertsattachtocase) -- [update](attachments_client.AttachmentsSubClient.md#update) - -## Methods - -### add - -▸ **add**(`params`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -Adds an attachment to a case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`AddArgs`](attachments_client._internal_namespace.AddArgs.md) | - -#### Returns - -`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/client.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L35) - -___ - -### delete - -▸ **delete**(`deleteArgs`): `Promise`<`void`\> - -Deletes a single attachment for a specific case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deleteArgs` | [`DeleteArgs`](attachments_client._internal_namespace.DeleteArgs.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/client.ts:43](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L43) - -___ - -### deleteAll - -▸ **deleteAll**(`deleteAllArgs`): `Promise`<`void`\> - -Deletes all attachments associated with a single case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deleteAllArgs` | [`DeleteAllArgs`](attachments_client._internal_namespace.DeleteAllArgs.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/client.ts:39](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L39) - -___ - -### find - -▸ **find**(`findArgs`): `Promise`<[`ICommentsResponse`](typedoc_interfaces.ICommentsResponse.md)\> - -Retrieves all comments matching the search criteria. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `findArgs` | [`FindArgs`](attachments_client._internal_namespace.FindArgs.md) | - -#### Returns - -`Promise`<[`ICommentsResponse`](typedoc_interfaces.ICommentsResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/client.ts:47](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L47) - -___ - -### get - -▸ **get**(`getArgs`): `Promise`<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }\> - -Retrieves a single attachment for a case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `getArgs` | [`GetArgs`](attachments_client._internal_namespace.GetArgs.md) | - -#### Returns - -`Promise`<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }\> - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/client.ts:59](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L59) - -___ - -### getAll - -▸ **getAll**(`getAllArgs`): `Promise`<[`IAllCommentsResponse`](typedoc_interfaces.IAllCommentsResponse.md)\> - -Gets all attachments for a single case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `getAllArgs` | [`GetAllArgs`](attachments_client._internal_namespace.GetAllArgs.md) | - -#### Returns - -`Promise`<[`IAllCommentsResponse`](typedoc_interfaces.IAllCommentsResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/client.ts:55](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L55) - -___ - -### getAllAlertsAttachToCase - -▸ **getAllAlertsAttachToCase**(`params`): `Promise`<{ `attached_at`: `string` = rt.string; `id`: `string` = rt.string; `index`: `string` = rt.string }[]\> - -Retrieves all alerts attach to a case given a single case ID - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`GetAllAlertsAttachToCase`](attachments_client._internal_namespace.GetAllAlertsAttachToCase.md) | - -#### Returns - -`Promise`<{ `attached_at`: `string` = rt.string; `id`: `string` = rt.string; `index`: `string` = rt.string }[]\> - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/client.ts:51](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L51) - -___ - -### update - -▸ **update**(`updateArgs`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -Updates a specific attachment. - -The request must include all fields for the attachment. Even the fields that are not changing. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `updateArgs` | [`UpdateArgs`](attachments_client._internal_namespace.UpdateArgs.md) | - -#### Returns - -`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/attachments/client.ts:65](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L65) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_client.casessubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_client.casessubclient.md deleted file mode 100644 index df4d1bdf7966f2..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_client.casessubclient.md +++ /dev/null @@ -1,249 +0,0 @@ -[Cases Client API Interface](../README.md) / [cases/client](../modules/cases_client.md) / CasesSubClient - -# Interface: CasesSubClient - -[cases/client](../modules/cases_client.md).CasesSubClient - -API for interacting with the cases entities. - -## Table of contents - -### Methods - -- [create](cases_client.CasesSubClient.md#create) -- [delete](cases_client.CasesSubClient.md#delete) -- [find](cases_client.CasesSubClient.md#find) -- [get](cases_client.CasesSubClient.md#get) -- [getCasesByAlertID](cases_client.CasesSubClient.md#getcasesbyalertid) -- [getReporters](cases_client.CasesSubClient.md#getreporters) -- [getTags](cases_client.CasesSubClient.md#gettags) -- [push](cases_client.CasesSubClient.md#push) -- [resolve](cases_client.CasesSubClient.md#resolve) -- [update](cases_client.CasesSubClient.md#update) - -## Methods - -### create - -▸ **create**(`data`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -Creates a case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`ICasePostRequest`](typedoc_interfaces.ICasePostRequest.md) | - -#### Returns - -`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:51](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L51) - -___ - -### delete - -▸ **delete**(`ids`): `Promise`<`void`\> - -Delete a case and all its comments. - -**`params`** ids an array of case IDs to delete - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ids` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L80) - -___ - -### find - -▸ **find**(`params`): `Promise`<[`ICasesFindResponse`](typedoc_interfaces.ICasesFindResponse.md)\> - -Returns cases that match the search criteria. - -If the `owner` field is left empty then all the cases that the user has access to will be returned. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`ICasesFindRequest`](typedoc_interfaces.ICasesFindRequest.md) | - -#### Returns - -`Promise`<[`ICasesFindResponse`](typedoc_interfaces.ICasesFindResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:57](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L57) - -___ - -### get - -▸ **get**(`params`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -Retrieves a single case with the specified ID. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`GetParams`](cases_get.GetParams.md) | - -#### Returns - -`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:61](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L61) - -___ - -### getCasesByAlertID - -▸ **getCasesByAlertID**(`params`): `Promise`<{ `id`: `string` = rt.string; `title`: `string` = rt.string }[]\> - -Retrieves the cases ID and title that have the requested alert attached to them - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`CasesByAlertIDParams`](cases_get.CasesByAlertIDParams.md) | - -#### Returns - -`Promise`<{ `id`: `string` = rt.string; `title`: `string` = rt.string }[]\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:92](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L92) - -___ - -### getReporters - -▸ **getReporters**(`params`): `Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` }[]\> - -Retrieves all the reporters across all accessible cases. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.owner` | `undefined` \| `string` \| `string`[] | - -#### Returns - -`Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` }[]\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:88](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L88) - -___ - -### getTags - -▸ **getTags**(`params`): `Promise`<`string`[]\> - -Retrieves all the tags across all cases the user making the request has access to. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.owner` | `undefined` \| `string` \| `string`[] | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:84](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L84) - -___ - -### push - -▸ **push**(`args`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -Pushes a specific case to an external system. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | [`PushParams`](cases_push.PushParams.md) | - -#### Returns - -`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:70](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L70) - -___ - -### resolve - -▸ **resolve**(`params`): `Promise`<[`ICaseResolveResponse`](typedoc_interfaces.ICaseResolveResponse.md)\> - -**`experimental`** -Retrieves a single case resolving the specified ID. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`GetParams`](cases_get.GetParams.md) | - -#### Returns - -`Promise`<[`ICaseResolveResponse`](typedoc_interfaces.ICaseResolveResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:66](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L66) - -___ - -### update - -▸ **update**(`cases`): `Promise`<[`ICasesResponse`](typedoc_interfaces.ICasesResponse.md)\> - -Update the specified cases with the passed in values. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cases` | [`ICasesPatchRequest`](typedoc_interfaces.ICasesPatchRequest.md) | - -#### Returns - -`Promise`<[`ICasesResponse`](typedoc_interfaces.ICasesResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/client.ts:74](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L74) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.casesbyalertidparams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.casesbyalertidparams.md deleted file mode 100644 index 2e0cf957be8e35..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.casesbyalertidparams.md +++ /dev/null @@ -1,44 +0,0 @@ -[Cases Client API Interface](../README.md) / [cases/get](../modules/cases_get.md) / CasesByAlertIDParams - -# Interface: CasesByAlertIDParams - -[cases/get](../modules/cases_get.md).CasesByAlertIDParams - -Parameters for finding cases IDs using an alert ID - -## Table of contents - -### Properties - -- [alertID](cases_get.CasesByAlertIDParams.md#alertid) -- [options](cases_get.CasesByAlertIDParams.md#options) - -## Properties - -### alertID - -• **alertID**: `string` - -The alert ID to search for - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/get.ts:45](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L45) - -___ - -### options - -• **options**: `Object` - -The filtering options when searching for associated cases. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `owner` | `undefined` \| `string` \| `string`[] | - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/get.ts:49](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L49) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.getparams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.getparams.md deleted file mode 100644 index ccd09fd4db48ce..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.getparams.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [cases/get](../modules/cases_get.md) / GetParams - -# Interface: GetParams - -[cases/get](../modules/cases_get.md).GetParams - -The parameters for retrieving a case - -## Table of contents - -### Properties - -- [id](cases_get.GetParams.md#id) -- [includeComments](cases_get.GetParams.md#includecomments) - -## Properties - -### id - -• **id**: `string` - -Case ID - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/get.ts:144](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L144) - -___ - -### includeComments - -• `Optional` **includeComments**: `boolean` - -Whether to include the attachments for a case in the response - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/get.ts:148](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L148) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_push.pushparams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_push.pushparams.md deleted file mode 100644 index 436850a7b64fd8..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_push.pushparams.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [cases/push](../modules/cases_push.md) / PushParams - -# Interface: PushParams - -[cases/push](../modules/cases_push.md).PushParams - -Parameters for pushing a case to an external system - -## Table of contents - -### Properties - -- [caseId](cases_push.PushParams.md#caseid) -- [connectorId](cases_push.PushParams.md#connectorid) - -## Properties - -### caseId - -• **caseId**: `string` - -The ID of a case - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/push.ts:48](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/push.ts#L48) - -___ - -### connectorId - -• **connectorId**: `string` - -The ID of an external system to push to - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/push.ts:52](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/push.ts#L52) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Action.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Action.md deleted file mode 100644 index 7f8e04653acf6b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Action.md +++ /dev/null @@ -1,72 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Action - -# Interface: Action - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Action - -## Hierarchy - -- [`ActionUpdate`](client._internal_namespace.ActionUpdate.md) - - ↳ **`Action`** - -## Table of contents - -### Properties - -- [actionTypeId](client._internal_namespace.Action.md#actiontypeid) -- [config](client._internal_namespace.Action.md#config) -- [name](client._internal_namespace.Action.md#name) -- [secrets](client._internal_namespace.Action.md#secrets) - -## Properties - -### actionTypeId - -• **actionTypeId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:19 - -___ - -### config - -• **config**: [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) - -#### Inherited from - -[ActionUpdate](client._internal_namespace.ActionUpdate.md).[config](client._internal_namespace.ActionUpdate.md#config) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:15 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -[ActionUpdate](client._internal_namespace.ActionUpdate.md).[name](client._internal_namespace.ActionUpdate.md#name) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:14 - -___ - -### secrets - -• **secrets**: [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) - -#### Inherited from - -[ActionUpdate](client._internal_namespace.ActionUpdate.md).[secrets](client._internal_namespace.ActionUpdate.md#secrets) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:16 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutionSource.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutionSource.md deleted file mode 100644 index 1b7033f5805c88..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutionSource.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionExecutionSource - -# Interface: ActionExecutionSource - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionExecutionSource - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Properties - -- [source](client._internal_namespace.ActionExecutionSource.md#source) -- [type](client._internal_namespace.ActionExecutionSource.md#type) - -## Properties - -### source - -• **source**: `T` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_execution_source.d.ts:8 - -___ - -### type - -• **type**: [`ActionExecutionSourceType`](../enums/client._internal_namespace.ActionExecutionSourceType.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_execution_source.d.ts:7 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutorContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutorContext.md deleted file mode 100644 index 093b2933ddfac5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutorContext.md +++ /dev/null @@ -1,112 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionExecutorContext - -# Interface: ActionExecutorContext - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionExecutorContext - -## Table of contents - -### Properties - -- [actionTypeRegistry](client._internal_namespace.ActionExecutorContext.md#actiontyperegistry) -- [encryptedSavedObjectsClient](client._internal_namespace.ActionExecutorContext.md#encryptedsavedobjectsclient) -- [eventLogger](client._internal_namespace.ActionExecutorContext.md#eventlogger) -- [getServices](client._internal_namespace.ActionExecutorContext.md#getservices) -- [logger](client._internal_namespace.ActionExecutorContext.md#logger) -- [preconfiguredActions](client._internal_namespace.ActionExecutorContext.md#preconfiguredactions) -- [spaces](client._internal_namespace.ActionExecutorContext.md#spaces) - -### Methods - -- [getActionsClientWithRequest](client._internal_namespace.ActionExecutorContext.md#getactionsclientwithrequest) - -## Properties - -### actionTypeRegistry - -• **actionTypeRegistry**: [`ActionTypeRegistryContract`](../modules/client._internal_namespace.md#actiontyperegistrycontract) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:16 - -___ - -### encryptedSavedObjectsClient - -• **encryptedSavedObjectsClient**: [`EncryptedSavedObjectsClient`](client._internal_namespace.EncryptedSavedObjectsClient.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:15 - -___ - -### eventLogger - -• **eventLogger**: [`IEventLogger`](client._internal_namespace.IEventLogger.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:17 - -___ - -### getServices - -• **getServices**: [`GetServicesFunction`](../modules/client._internal_namespace.md#getservicesfunction) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:13 - -___ - -### logger - -• **logger**: `Logger` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:11 - -___ - -### preconfiguredActions - -• **preconfiguredActions**: [`PreConfiguredAction`](client._internal_namespace.PreConfiguredAction.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets)\>[] - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:18 - -___ - -### spaces - -• `Optional` **spaces**: [`SpacesServiceStart`](client._internal_namespace.SpacesServiceStart.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:12 - -## Methods - -### getActionsClientWithRequest - -▸ **getActionsClientWithRequest**(`request`, `authorizationContext?`): `Promise`<`PublicMethodsOf`<[`ActionsClient`](../classes/client._internal_namespace.ActionsClient.md)\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | -| `authorizationContext?` | [`ActionExecutionSource`](client._internal_namespace.ActionExecutionSource.md)<`unknown`\> | - -#### Returns - -`Promise`<`PublicMethodsOf`<[`ActionsClient`](../classes/client._internal_namespace.ActionsClient.md)\>\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:14 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionResult.md deleted file mode 100644 index 7a303e0216b3a7..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionResult.md +++ /dev/null @@ -1,90 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionResult - -# Interface: ActionResult - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionResult - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | - -## Hierarchy - -- **`ActionResult`** - - ↳ [`FindActionResult`](client._internal_namespace.FindActionResult.md) - - ↳ [`PreConfiguredAction`](client._internal_namespace.PreConfiguredAction.md) - -## Table of contents - -### Properties - -- [actionTypeId](client._internal_namespace.ActionResult.md#actiontypeid) -- [config](client._internal_namespace.ActionResult.md#config) -- [id](client._internal_namespace.ActionResult.md#id) -- [isMissingSecrets](client._internal_namespace.ActionResult.md#ismissingsecrets) -- [isPreconfigured](client._internal_namespace.ActionResult.md#ispreconfigured) -- [name](client._internal_namespace.ActionResult.md#name) - -## Properties - -### actionTypeId - -• **actionTypeId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:50 - -___ - -### config - -• `Optional` **config**: `Config` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:53 - -___ - -### id - -• **id**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:49 - -___ - -### isMissingSecrets - -• `Optional` **isMissingSecrets**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:52 - -___ - -### isPreconfigured - -• **isPreconfigured**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:54 - -___ - -### name - -• **name**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:51 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType-1.md deleted file mode 100644 index ac0b15f74c84de..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType-1.md +++ /dev/null @@ -1,120 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionType - -# Interface: ActionType - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionType - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | -| `Secrets` | extends [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) = [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) | -| `Params` | extends [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) = [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) | -| `ExecutorResultData` | `void` | - -## Table of contents - -### Properties - -- [executor](client._internal_namespace.ActionType-1.md#executor) -- [id](client._internal_namespace.ActionType-1.md#id) -- [maxAttempts](client._internal_namespace.ActionType-1.md#maxattempts) -- [minimumLicenseRequired](client._internal_namespace.ActionType-1.md#minimumlicenserequired) -- [name](client._internal_namespace.ActionType-1.md#name) -- [validate](client._internal_namespace.ActionType-1.md#validate) - -### Methods - -- [renderParameterTemplates](client._internal_namespace.ActionType-1.md#renderparametertemplates) - -## Properties - -### executor - -• **executor**: [`ExecutorType`](../modules/client._internal_namespace.md#executortype)<`Config`, `Secrets`, `Params`, `ExecutorResultData`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:82 - -___ - -### id - -• **id**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:71 - -___ - -### maxAttempts - -• `Optional` **maxAttempts**: `number` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:73 - -___ - -### minimumLicenseRequired - -• **minimumLicenseRequired**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:74 - -___ - -### name - -• **name**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:72 - -___ - -### validate - -• `Optional` **validate**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `config?` | [`ValidatorType`](client._internal_namespace.ValidatorType.md)<`Config`\> | -| `params?` | [`ValidatorType`](client._internal_namespace.ValidatorType.md)<`Params`\> | -| `secrets?` | [`ValidatorType`](client._internal_namespace.ValidatorType.md)<`Secrets`\> | -| `connector?` | (`config`: `Config`, `secrets`: `Secrets`) => ``null`` \| `string` | - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:75 - -## Methods - -### renderParameterTemplates - -▸ `Optional` **renderParameterTemplates**(`params`, `variables`, `actionId?`): `Params` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Params` | -| `variables` | `Record`<`string`, `unknown`\> | -| `actionId?` | `string` | - -#### Returns - -`Params` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:81 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType.md deleted file mode 100644 index 286e699d5c2f7f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType.md +++ /dev/null @@ -1,76 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionType - -# Interface: ActionType - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionType - -## Table of contents - -### Properties - -- [enabled](client._internal_namespace.ActionType.md#enabled) -- [enabledInConfig](client._internal_namespace.ActionType.md#enabledinconfig) -- [enabledInLicense](client._internal_namespace.ActionType.md#enabledinlicense) -- [id](client._internal_namespace.ActionType.md#id) -- [minimumLicenseRequired](client._internal_namespace.ActionType.md#minimumlicenserequired) -- [name](client._internal_namespace.ActionType.md#name) - -## Properties - -### enabled - -• **enabled**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:5 - -___ - -### enabledInConfig - -• **enabledInConfig**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:6 - -___ - -### enabledInLicense - -• **enabledInLicense**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:7 - -___ - -### id - -• **id**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:3 - -___ - -### minimumLicenseRequired - -• **minimumLicenseRequired**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:8 - -___ - -### name - -• **name**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorOptions.md deleted file mode 100644 index 9c06e78c9c1990..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorOptions.md +++ /dev/null @@ -1,95 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionTypeExecutorOptions - -# Interface: ActionTypeExecutorOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionTypeExecutorOptions - -## Type parameters - -| Name | -| :------ | -| `Config` | -| `Secrets` | -| `Params` | - -## Table of contents - -### Properties - -- [actionId](client._internal_namespace.ActionTypeExecutorOptions.md#actionid) -- [config](client._internal_namespace.ActionTypeExecutorOptions.md#config) -- [isEphemeral](client._internal_namespace.ActionTypeExecutorOptions.md#isephemeral) -- [params](client._internal_namespace.ActionTypeExecutorOptions.md#params) -- [secrets](client._internal_namespace.ActionTypeExecutorOptions.md#secrets) -- [services](client._internal_namespace.ActionTypeExecutorOptions.md#services) -- [taskInfo](client._internal_namespace.ActionTypeExecutorOptions.md#taskinfo) - -## Properties - -### actionId - -• **actionId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:40 - -___ - -### config - -• **config**: `Config` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:42 - -___ - -### isEphemeral - -• `Optional` **isEphemeral**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:45 - -___ - -### params - -• **params**: `Params` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:44 - -___ - -### secrets - -• **secrets**: `Secrets` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:43 - -___ - -### services - -• **services**: [`Services`](client._internal_namespace.Services.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:41 - -___ - -### taskInfo - -• `Optional` **taskInfo**: [`TaskInfo`](client._internal_namespace.TaskInfo.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:46 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorResult.md deleted file mode 100644 index 039de06431a7c3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorResult.md +++ /dev/null @@ -1,82 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionTypeExecutorResult - -# Interface: ActionTypeExecutorResult - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionTypeExecutorResult - -## Type parameters - -| Name | -| :------ | -| `Data` | - -## Table of contents - -### Properties - -- [actionId](client._internal_namespace.ActionTypeExecutorResult.md#actionid) -- [data](client._internal_namespace.ActionTypeExecutorResult.md#data) -- [message](client._internal_namespace.ActionTypeExecutorResult.md#message) -- [retry](client._internal_namespace.ActionTypeExecutorResult.md#retry) -- [serviceMessage](client._internal_namespace.ActionTypeExecutorResult.md#servicemessage) -- [status](client._internal_namespace.ActionTypeExecutorResult.md#status) - -## Properties - -### actionId - -• **actionId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:20 - -___ - -### data - -• `Optional` **data**: `Data` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:24 - -___ - -### message - -• `Optional` **message**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:22 - -___ - -### retry - -• `Optional` **retry**: ``null`` \| `boolean` \| `Date` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:25 - -___ - -### serviceMessage - -• `Optional` **serviceMessage**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:23 - -___ - -### status - -• **status**: ``"error"`` \| ``"ok"`` - -#### Defined in - -x-pack/plugins/actions/target/types/common/types.d.ts:21 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeRegistryOpts.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeRegistryOpts.md deleted file mode 100644 index 2f83edd5720f06..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeRegistryOpts.md +++ /dev/null @@ -1,76 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionTypeRegistryOpts - -# Interface: ActionTypeRegistryOpts - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionTypeRegistryOpts - -## Table of contents - -### Properties - -- [actionsConfigUtils](client._internal_namespace.ActionTypeRegistryOpts.md#actionsconfigutils) -- [licenseState](client._internal_namespace.ActionTypeRegistryOpts.md#licensestate) -- [licensing](client._internal_namespace.ActionTypeRegistryOpts.md#licensing) -- [preconfiguredActions](client._internal_namespace.ActionTypeRegistryOpts.md#preconfiguredactions) -- [taskManager](client._internal_namespace.ActionTypeRegistryOpts.md#taskmanager) -- [taskRunnerFactory](client._internal_namespace.ActionTypeRegistryOpts.md#taskrunnerfactory) - -## Properties - -### actionsConfigUtils - -• **actionsConfigUtils**: [`ActionsConfigurationUtilities`](client._internal_namespace.ActionsConfigurationUtilities.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:11 - -___ - -### licenseState - -• **licenseState**: [`ILicenseState`](../modules/client._internal_namespace.md#ilicensestate) - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:12 - -___ - -### licensing - -• **licensing**: [`LicensingPluginSetup`](client._internal_namespace.LicensingPluginSetup.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:8 - -___ - -### preconfiguredActions - -• **preconfiguredActions**: [`PreConfiguredAction`](client._internal_namespace.PreConfiguredAction.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets)\>[] - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:13 - -___ - -### taskManager - -• **taskManager**: [`TaskManagerSetupContract`](client._internal_namespace.TaskManagerSetupContract.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:9 - -___ - -### taskRunnerFactory - -• **taskRunnerFactory**: [`TaskRunnerFactory`](../classes/client._internal_namespace.TaskRunnerFactory.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:10 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionUpdate.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionUpdate.md deleted file mode 100644 index 1326f4f3b3361c..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionUpdate.md +++ /dev/null @@ -1,51 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionUpdate - -# Interface: ActionUpdate - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionUpdate - -## Hierarchy - -- [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) - - ↳ **`ActionUpdate`** - - ↳↳ [`Action`](client._internal_namespace.Action.md) - -## Table of contents - -### Properties - -- [config](client._internal_namespace.ActionUpdate.md#config) -- [name](client._internal_namespace.ActionUpdate.md#name) -- [secrets](client._internal_namespace.ActionUpdate.md#secrets) - -## Properties - -### config - -• **config**: [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:15 - -___ - -### name - -• **name**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:14 - -___ - -### secrets - -• **secrets**: [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:16 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsConfigurationUtilities.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsConfigurationUtilities.md deleted file mode 100644 index f2562a697f2553..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsConfigurationUtilities.md +++ /dev/null @@ -1,217 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionsConfigurationUtilities - -# Interface: ActionsConfigurationUtilities - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionsConfigurationUtilities - -## Table of contents - -### Methods - -- [ensureActionTypeEnabled](client._internal_namespace.ActionsConfigurationUtilities.md#ensureactiontypeenabled) -- [ensureHostnameAllowed](client._internal_namespace.ActionsConfigurationUtilities.md#ensurehostnameallowed) -- [ensureUriAllowed](client._internal_namespace.ActionsConfigurationUtilities.md#ensureuriallowed) -- [getCustomHostSettings](client._internal_namespace.ActionsConfigurationUtilities.md#getcustomhostsettings) -- [getMicrosoftGraphApiUrl](client._internal_namespace.ActionsConfigurationUtilities.md#getmicrosoftgraphapiurl) -- [getProxySettings](client._internal_namespace.ActionsConfigurationUtilities.md#getproxysettings) -- [getResponseSettings](client._internal_namespace.ActionsConfigurationUtilities.md#getresponsesettings) -- [getSSLSettings](client._internal_namespace.ActionsConfigurationUtilities.md#getsslsettings) -- [isActionTypeEnabled](client._internal_namespace.ActionsConfigurationUtilities.md#isactiontypeenabled) -- [isHostnameAllowed](client._internal_namespace.ActionsConfigurationUtilities.md#ishostnameallowed) -- [isUriAllowed](client._internal_namespace.ActionsConfigurationUtilities.md#isuriallowed) - -## Methods - -### ensureActionTypeEnabled - -▸ **ensureActionTypeEnabled**(`actionType`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionType` | `string` | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:10 - -___ - -### ensureHostnameAllowed - -▸ **ensureHostnameAllowed**(`hostname`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hostname` | `string` | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:8 - -___ - -### ensureUriAllowed - -▸ **ensureUriAllowed**(`uri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:9 - -___ - -### getCustomHostSettings - -▸ **getCustomHostSettings**(`targetUrl`): `undefined` \| `Readonly`<{ `smtp?`: `Readonly`<{ `ignoreTLS?`: `boolean` ; `requireTLS?`: `boolean` }\> ; `ssl?`: `Readonly`<{ `certificateAuthoritiesData?`: `string` ; `certificateAuthoritiesFiles?`: `string` \| `string`[] ; `rejectUnauthorized?`: `boolean` ; `verificationMode?`: ``"none"`` \| ``"certificate"`` \| ``"full"`` }\> } & { `url`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetUrl` | `string` | - -#### Returns - -`undefined` \| `Readonly`<{ `smtp?`: `Readonly`<{ `ignoreTLS?`: `boolean` ; `requireTLS?`: `boolean` }\> ; `ssl?`: `Readonly`<{ `certificateAuthoritiesData?`: `string` ; `certificateAuthoritiesFiles?`: `string` \| `string`[] ; `rejectUnauthorized?`: `boolean` ; `verificationMode?`: ``"none"`` \| ``"certificate"`` \| ``"full"`` }\> } & { `url`: `string` }\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:14 - -___ - -### getMicrosoftGraphApiUrl - -▸ **getMicrosoftGraphApiUrl**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:15 - -___ - -### getProxySettings - -▸ **getProxySettings**(): `undefined` \| [`ProxySettings`](client._internal_namespace.ProxySettings.md) - -#### Returns - -`undefined` \| [`ProxySettings`](client._internal_namespace.ProxySettings.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:12 - -___ - -### getResponseSettings - -▸ **getResponseSettings**(): [`ResponseSettings`](client._internal_namespace.ResponseSettings.md) - -#### Returns - -[`ResponseSettings`](client._internal_namespace.ResponseSettings.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:13 - -___ - -### getSSLSettings - -▸ **getSSLSettings**(): [`SSLSettings`](client._internal_namespace.SSLSettings.md) - -#### Returns - -[`SSLSettings`](client._internal_namespace.SSLSettings.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:11 - -___ - -### isActionTypeEnabled - -▸ **isActionTypeEnabled**(`actionType`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `actionType` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:7 - -___ - -### isHostnameAllowed - -▸ **isHostnameAllowed**(`hostname`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hostname` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:5 - -___ - -### isUriAllowed - -▸ **isUriAllowed**(`uri`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_config.d.ts:6 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsLicenseInformation.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsLicenseInformation.md deleted file mode 100644 index c7ab568b57c35e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsLicenseInformation.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionsLicenseInformation - -# Interface: ActionsLicenseInformation - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionsLicenseInformation - -## Table of contents - -### Properties - -- [enableAppLink](client._internal_namespace.ActionsLicenseInformation.md#enableapplink) -- [message](client._internal_namespace.ActionsLicenseInformation.md#message) -- [showAppLink](client._internal_namespace.ActionsLicenseInformation.md#showapplink) - -## Properties - -### enableAppLink - -• **enableAppLink**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:9 - -___ - -### message - -• **message**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:10 - -___ - -### showAppLink - -• **showAppLink**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:8 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AggregationBuilder.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AggregationBuilder.md deleted file mode 100644 index 9790711e77193b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AggregationBuilder.md +++ /dev/null @@ -1,68 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AggregationBuilder - -# Interface: AggregationBuilder - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AggregationBuilder - -## Table of contents - -### Methods - -- [build](client._internal_namespace.AggregationBuilder.md#build) -- [formatResponse](client._internal_namespace.AggregationBuilder.md#formatresponse) -- [getName](client._internal_namespace.AggregationBuilder.md#getname) - -## Methods - -### build - -▸ **build**(): `Record`<`string`, `AggregationsAggregationContainer`\> - -#### Returns - -`Record`<`string`, `AggregationsAggregationContainer`\> - -#### Defined in - -[x-pack/plugins/cases/server/client/metrics/types.ts:20](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/types.ts#L20) - -___ - -### formatResponse - -▸ **formatResponse**(`aggregations`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `aggregations` | [`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `actions` | `undefined` \| { isolateHost?: { isolate: { total: number; }; unisolate: { total: number; }; } \| undefined; } | -| `alerts` | `undefined` \| { count?: number \| undefined; hosts?: { total: number; values: { name: string \| undefined; id: string; count: number; }[]; } \| undefined; users?: { total: number; values: { name: string; count: number; }[]; } \| undefined; } | -| `connectors` | `undefined` \| { `total`: `number` = rt.number } | -| `lifespan` | `undefined` \| { `closeDate`: ``null`` \| `string` ; `creationDate`: `string` = rt.string; `statusInfo`: { openDuration: number; inProgressDuration: number; reopenDates: string[]; } = StatusInfoRt } | - -#### Defined in - -[x-pack/plugins/cases/server/client/metrics/types.ts:21](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/types.ts#L21) - -___ - -### getName - -▸ **getName**(): `string` - -#### Returns - -`string` - -#### Defined in - -[x-pack/plugins/cases/server/client/metrics/types.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/types.ts#L22) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Alert.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Alert.md deleted file mode 100644 index 71ae71dd5cfaf8..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Alert.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Alert - -# Interface: Alert - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Alert - -## Table of contents - -### Properties - -- [\_id](client._internal_namespace.Alert.md#_id) -- [\_index](client._internal_namespace.Alert.md#_index) -- [\_source](client._internal_namespace.Alert.md#_source) - -## Properties - -### \_id - -• **\_id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:233](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L233) - -___ - -### \_index - -• **\_index**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:234](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L234) - -___ - -### \_source - -• **\_source**: `Record`<`string`, `unknown`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:235](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L235) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertIdIndex.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertIdIndex.md deleted file mode 100644 index b9a09536ed21c4..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertIdIndex.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertIdIndex - -# Interface: AlertIdIndex - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertIdIndex - -## Table of contents - -### Properties - -- [id](client._internal_namespace.AlertIdIndex.md#id) -- [index](client._internal_namespace.AlertIdIndex.md#index) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:243](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L243) - -___ - -### index - -• **index**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:244](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L244) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertInfo.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertInfo.md deleted file mode 100644 index acf8e3b09b74f0..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertInfo.md +++ /dev/null @@ -1,34 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertInfo - -# Interface: AlertInfo - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertInfo - -This structure holds the alert ID and index from an alert comment - -## Table of contents - -### Properties - -- [id](client._internal_namespace.AlertInfo.md#id) -- [index](client._internal_namespace.AlertInfo.md#index) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/common/types.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/common/types.ts#L15) - -___ - -### index - -• **index**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/common/types.ts:16](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/common/types.ts#L16) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertsResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertsResponse.md deleted file mode 100644 index aae855d5d0d4a4..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertsResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertsResponse - -# Interface: AlertsResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertsResponse - -## Table of contents - -### Properties - -- [docs](client._internal_namespace.AlertsResponse.md#docs) - -## Properties - -### docs - -• **docs**: [`Alert`](client._internal_namespace.Alert.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:239](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L239) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AppCategory.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AppCategory.md deleted file mode 100644 index 7ab9c4c95ff662..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AppCategory.md +++ /dev/null @@ -1,83 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AppCategory - -# Interface: AppCategory - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AppCategory - -A category definition for nav links to know where to sort them in the left hand nav - -## Table of contents - -### Properties - -- [ariaLabel](client._internal_namespace.AppCategory.md#arialabel) -- [euiIconType](client._internal_namespace.AppCategory.md#euiicontype) -- [id](client._internal_namespace.AppCategory.md#id) -- [label](client._internal_namespace.AppCategory.md#label) -- [order](client._internal_namespace.AppCategory.md#order) - -## Properties - -### ariaLabel - -• `Optional` **ariaLabel**: `string` - -If the visual label isn't appropriate for screen readers, -can override it here - -#### Defined in - -src/core/target/types/types/app_category.d.ts:20 - -___ - -### euiIconType - -• `Optional` **euiIconType**: `string` - -Define an icon to be used for the category -If the category is only 1 item, and no icon is defined, will default to the product icon -Defaults to initials if no icon is defined - -#### Defined in - -src/core/target/types/types/app_category.d.ts:32 - -___ - -### id - -• **id**: `string` - -Unique identifier for the categories - -#### Defined in - -src/core/target/types/types/app_category.d.ts:10 - -___ - -### label - -• **label**: `string` - -Label used for category name. -Also used as aria-label if one isn't set. - -#### Defined in - -src/core/target/types/types/app_category.d.ts:15 - -___ - -### order - -• `Optional` **order**: `number` - -The order that categories will be sorted in -Prefer large steps between categories to allow for further editing -(Default categories are in steps of 1000) - -#### Defined in - -src/core/target/types/types/app_category.d.ts:26 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AttachedToCaseArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AttachedToCaseArgs.md deleted file mode 100644 index 86ea1605c13741..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AttachedToCaseArgs.md +++ /dev/null @@ -1,55 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AttachedToCaseArgs - -# Interface: AttachedToCaseArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AttachedToCaseArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`AttachedToCaseArgs`** - - ↳↳ [`CountActionsAttachedToCaseArgs`](client._internal_namespace.CountActionsAttachedToCaseArgs.md) - -## Table of contents - -### Properties - -- [caseId](client._internal_namespace.AttachedToCaseArgs.md#caseid) -- [filter](client._internal_namespace.AttachedToCaseArgs.md#filter) -- [unsecuredSavedObjectsClient](client._internal_namespace.AttachedToCaseArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### caseId - -• **caseId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:33](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L33) - -___ - -### filter - -• `Optional` **filter**: `KueryNode` - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L34) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Attributes.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Attributes.md deleted file mode 100644 index fd8a32f7afb6bf..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Attributes.md +++ /dev/null @@ -1,84 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Attributes - -# Interface: Attributes - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Attributes - -## Table of contents - -### Properties - -- [action](client._internal_namespace.Attributes.md#action) -- [created\_at](client._internal_namespace.Attributes.md#created_at) -- [created\_by](client._internal_namespace.Attributes.md#created_by) -- [owner](client._internal_namespace.Attributes.md#owner) -- [payload](client._internal_namespace.Attributes.md#payload) -- [type](client._internal_namespace.Attributes.md#type) - -## Properties - -### action - -• **action**: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:84](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L84) - -___ - -### created\_at - -• **created\_at**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L85) - -___ - -### created\_by - -• **created\_by**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:86](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L86) - -___ - -### owner - -• **owner**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:87](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L87) - -___ - -### payload - -• **payload**: `Record`<`string`, `unknown`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:89](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L89) - -___ - -### type - -• **type**: ``"description"`` \| ``"tags"`` \| ``"title"`` \| ``"connector"`` \| ``"settings"`` \| ``"status"`` \| ``"comment"`` \| ``"pushed"`` \| ``"create_case"`` \| ``"delete_case"`` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:88](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L88) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditEvent.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditEvent.md deleted file mode 100644 index d0bbaabfc416b4..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditEvent.md +++ /dev/null @@ -1,59 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuditEvent - -# Interface: AuditEvent - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuditEvent - -Audit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.12/index.html - -If you add additional fields to the schema ensure you update the Kibana Filebeat module: -https://github.com/elastic/beats/tree/master/filebeat/module/kibana - -## Hierarchy - -- `LogMeta` - - ↳ **`AuditEvent`** - -## Table of contents - -### Properties - -- [kibana](client._internal_namespace.AuditEvent.md#kibana) -- [message](client._internal_namespace.AuditEvent.md#message) - -## Properties - -### kibana - -• `Optional` **kibana**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `add_to_spaces?` | readonly `string`[] | Set of space IDs that a saved object was shared to. | -| `authentication_provider?` | `string` | Name of authentication provider associated with a login event. | -| `authentication_realm?` | `string` | Name of Elasticsearch realm that has authenticated the user. | -| `authentication_type?` | `string` | Type of authentication provider associated with a login event. | -| `delete_from_spaces?` | readonly `string`[] | Set of space IDs that a saved object was removed from. | -| `lookup_realm?` | `string` | Name of Elasticsearch realm where the user details were retrieved from. | -| `saved_object?` | `Object` | Saved object that was created, changed, deleted or accessed as part of this event. | -| `saved_object.id` | `string` | - | -| `saved_object.type` | `string` | - | -| `session_id?` | `string` | The ID of the user session associated with this event. Each login attempt results in a unique session id. | -| `space_id?` | `string` | The ID of the space associated with this event. | - -#### Defined in - -x-pack/plugins/security/target/types/server/audit/audit_events.d.ts:14 - -___ - -### message - -• **message**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/server/audit/audit_events.d.ts:13 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditLogger.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditLogger.md deleted file mode 100644 index c4caafd67c08dc..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditLogger.md +++ /dev/null @@ -1,52 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuditLogger - -# Interface: AuditLogger - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuditLogger - -## Table of contents - -### Methods - -- [log](client._internal_namespace.AuditLogger.md#log) - -## Methods - -### log - -▸ **log**(`event`): `void` - -Logs an [AuditEvent](client._internal_namespace.AuditEvent.md) and automatically adds meta data about the -current user, space and correlation id. - -Guidelines around what events should be logged and how they should be -structured can be found in: `/x-pack/plugins/security/README.md` - -**`example`** -```typescript -const auditLogger = securitySetup.audit.asScoped(request); -auditLogger.log({ - message: 'User is updating dashboard [id=123]', - event: { - action: 'saved_object_update', - outcome: 'unknown' - }, - kibana: { - saved_object: { type: 'dashboard', id: '123' } - }, -}); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `undefined` \| [`AuditEvent`](client._internal_namespace.AuditEvent.md) | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/security/target/types/server/audit/audit_service.d.ts:32 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthFilterHelpers.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthFilterHelpers.md deleted file mode 100644 index c4117202317cc9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthFilterHelpers.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthFilterHelpers - -# Interface: AuthFilterHelpers - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthFilterHelpers - -Defines the helper methods and necessary information for authorizing the find API's request. - -## Table of contents - -### Properties - -- [ensureSavedObjectsAreAuthorized](client._internal_namespace.AuthFilterHelpers.md#ensuresavedobjectsareauthorized) -- [filter](client._internal_namespace.AuthFilterHelpers.md#filter) - -## Properties - -### ensureSavedObjectsAreAuthorized - -• **ensureSavedObjectsAreAuthorized**: [`EnsureSOAuthCallback`](../modules/client._internal_namespace.md#ensuresoauthcallback) - -Utility function for checking that the returned entities are in fact authorized for the user making the request - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:123](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L123) - -___ - -### filter - -• `Optional` **filter**: `KueryNode` - -The owner filter to pass to the saved object client's find operation that is scoped to the authorized owners - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:119](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L119) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticatedUser.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticatedUser.md deleted file mode 100644 index 69dc207747edfb..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticatedUser.md +++ /dev/null @@ -1,170 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthenticatedUser - -# Interface: AuthenticatedUser - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthenticatedUser - -Represents the currently authenticated user. - -## Hierarchy - -- [`User`](client._internal_namespace.User.md) - - ↳ **`AuthenticatedUser`** - -## Table of contents - -### Properties - -- [authentication\_provider](client._internal_namespace.AuthenticatedUser.md#authentication_provider) -- [authentication\_realm](client._internal_namespace.AuthenticatedUser.md#authentication_realm) -- [authentication\_type](client._internal_namespace.AuthenticatedUser.md#authentication_type) -- [email](client._internal_namespace.AuthenticatedUser.md#email) -- [enabled](client._internal_namespace.AuthenticatedUser.md#enabled) -- [full\_name](client._internal_namespace.AuthenticatedUser.md#full_name) -- [lookup\_realm](client._internal_namespace.AuthenticatedUser.md#lookup_realm) -- [metadata](client._internal_namespace.AuthenticatedUser.md#metadata) -- [roles](client._internal_namespace.AuthenticatedUser.md#roles) -- [username](client._internal_namespace.AuthenticatedUser.md#username) - -## Properties - -### authentication\_provider - -• **authentication\_provider**: [`AuthenticationProvider`](client._internal_namespace.AuthenticationProvider.md) - -The authentication provider that used to authenticate user. - -#### Defined in - -x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:22 - -___ - -### authentication\_realm - -• **authentication\_realm**: [`UserRealm`](client._internal_namespace.UserRealm.md) - -The name and type of the Realm that has authenticated the user. - -#### Defined in - -x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:14 - -___ - -### authentication\_type - -• **authentication\_type**: `string` - -The AuthenticationType used by ES to authenticate the user. - -**`example`** "realm" | "api_key" | "token" | "anonymous" | "internal" - -#### Defined in - -x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:28 - -___ - -### email - -• `Optional` **email**: `string` - -#### Inherited from - -[User](client._internal_namespace.User.md).[email](client._internal_namespace.User.md#email) - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:3 - -___ - -### enabled - -• **enabled**: `boolean` - -#### Inherited from - -[User](client._internal_namespace.User.md).[enabled](client._internal_namespace.User.md#enabled) - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:6 - -___ - -### full\_name - -• `Optional` **full\_name**: `string` - -#### Inherited from - -[User](client._internal_namespace.User.md).[full_name](client._internal_namespace.User.md#full_name) - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:4 - -___ - -### lookup\_realm - -• **lookup\_realm**: [`UserRealm`](client._internal_namespace.UserRealm.md) - -The name and type of the Realm where the user information were retrieved from. - -#### Defined in - -x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:18 - -___ - -### metadata - -• `Optional` **metadata**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_deprecated?` | `boolean` | -| `_deprecated_reason?` | `string` | -| `_reserved` | `boolean` | - -#### Inherited from - -[User](client._internal_namespace.User.md).[metadata](client._internal_namespace.User.md#metadata) - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:7 - -___ - -### roles - -• **roles**: readonly `string`[] - -#### Inherited from - -[User](client._internal_namespace.User.md).[roles](client._internal_namespace.User.md#roles) - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:5 - -___ - -### username - -• **username**: `string` - -#### Inherited from - -[User](client._internal_namespace.User.md).[username](client._internal_namespace.User.md#username) - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:2 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticationProvider.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticationProvider.md deleted file mode 100644 index a10edc042b5286..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticationProvider.md +++ /dev/null @@ -1,34 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthenticationProvider - -# Interface: AuthenticationProvider - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthenticationProvider - -Type and name tuple to identify provider used to authenticate user. - -## Table of contents - -### Properties - -- [name](client._internal_namespace.AuthenticationProvider.md#name) -- [type](client._internal_namespace.AuthenticationProvider.md#type) - -## Properties - -### name - -• **name**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/common/model/authentication_provider.d.ts:6 - -___ - -### type - -• **type**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/common/model/authentication_provider.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationMode-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationMode-1.md deleted file mode 100644 index ff75cd19e524c3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationMode-1.md +++ /dev/null @@ -1,31 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthorizationMode - -# Interface: AuthorizationMode - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthorizationMode - -## Table of contents - -### Methods - -- [useRbacForRequest](client._internal_namespace.AuthorizationMode-1.md#userbacforrequest) - -## Methods - -### useRbacForRequest - -▸ **useRbacForRequest**(`request`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/mode.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationServiceSetup.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationServiceSetup.md deleted file mode 100644 index 5011fe972f36eb..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationServiceSetup.md +++ /dev/null @@ -1,71 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthorizationServiceSetup - -# Interface: AuthorizationServiceSetup - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthorizationServiceSetup - -Authorization services available on the setup contract of the security plugin. - -## Table of contents - -### Properties - -- [actions](client._internal_namespace.AuthorizationServiceSetup.md#actions) -- [checkPrivilegesDynamicallyWithRequest](client._internal_namespace.AuthorizationServiceSetup.md#checkprivilegesdynamicallywithrequest) -- [checkPrivilegesWithRequest](client._internal_namespace.AuthorizationServiceSetup.md#checkprivilegeswithrequest) -- [checkSavedObjectsPrivilegesWithRequest](client._internal_namespace.AuthorizationServiceSetup.md#checksavedobjectsprivilegeswithrequest) -- [mode](client._internal_namespace.AuthorizationServiceSetup.md#mode) - -## Properties - -### actions - -• **actions**: [`Actions`](../classes/client._internal_namespace.Actions.md) - -Actions are used to create the "actions" that are associated with Elasticsearch's -application privileges, and are used to perform the authorization checks implemented -by the various `checkPrivilegesWithRequest` derivatives. - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:52 - -___ - -### checkPrivilegesDynamicallyWithRequest - -• **checkPrivilegesDynamicallyWithRequest**: [`CheckPrivilegesDynamicallyWithRequest`](../modules/client._internal_namespace.md#checkprivilegesdynamicallywithrequest) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:54 - -___ - -### checkPrivilegesWithRequest - -• **checkPrivilegesWithRequest**: [`CheckPrivilegesWithRequest`](../modules/client._internal_namespace.md#checkprivilegeswithrequest) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:53 - -___ - -### checkSavedObjectsPrivilegesWithRequest - -• **checkSavedObjectsPrivilegesWithRequest**: [`CheckSavedObjectsPrivilegesWithRequest`](../modules/client._internal_namespace.md#checksavedobjectsprivilegeswithrequest) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:55 - -___ - -### mode - -• **mode**: [`AuthorizationMode`](client._internal_namespace.AuthorizationMode-1.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:56 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BeforeSaveContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BeforeSaveContext.md deleted file mode 100644 index 6e52bf637eadaf..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BeforeSaveContext.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BeforeSaveContext - -# Interface: BeforeSaveContext - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BeforeSaveContext - -## Table of contents - -### Properties - -- [taskInstance](client._internal_namespace.BeforeSaveContext.md#taskinstance) - -## Properties - -### taskInstance - -• **taskInstance**: [`TaskInstance`](client._internal_namespace.TaskInstance.md) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderParameters.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderParameters.md deleted file mode 100644 index c91716f5b2248f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderParameters.md +++ /dev/null @@ -1,205 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BuilderParameters - -# Interface: BuilderParameters - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BuilderParameters - -## Table of contents - -### Properties - -- [comment](client._internal_namespace.BuilderParameters.md#comment) -- [connector](client._internal_namespace.BuilderParameters.md#connector) -- [create\_case](client._internal_namespace.BuilderParameters.md#create_case) -- [delete\_case](client._internal_namespace.BuilderParameters.md#delete_case) -- [description](client._internal_namespace.BuilderParameters.md#description) -- [pushed](client._internal_namespace.BuilderParameters.md#pushed) -- [settings](client._internal_namespace.BuilderParameters.md#settings) -- [status](client._internal_namespace.BuilderParameters.md#status) -- [tags](client._internal_namespace.BuilderParameters.md#tags) -- [title](client._internal_namespace.BuilderParameters.md#title) - -## Properties - -### comment - -• **comment**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.attachment` | { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:44](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L44) - -___ - -### connector - -• **connector**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.connector` | { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:49](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L49) - -___ - -### create\_case - -• **create\_case**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.connector` | { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } | -| `parameters.payload.description` | `string` | -| `parameters.payload.owner` | `string` | -| `parameters.payload.settings` | { syncAlerts: boolean; } | -| `parameters.payload.tags` | `string`[] | -| `parameters.payload.title` | `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:56](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L56) - -___ - -### delete\_case - -• **delete\_case**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:61](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L61) - -___ - -### description - -• **description**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.description` | `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L25) - -___ - -### pushed - -• **pushed**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.externalService` | { `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT } | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L34) - -___ - -### settings - -• **settings**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.settings` | `Object` | -| `parameters.payload.settings.syncAlerts` | `boolean` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:41](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L41) - -___ - -### status - -• **status**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.status` | [`CaseStatuses`](../enums/client._internal_namespace.CaseStatuses.md) | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L28) - -___ - -### tags - -• **tags**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.tags` | `string`[] | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:31](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L31) - -___ - -### title - -• **title**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameters` | `Object` | -| `parameters.payload` | `Object` | -| `parameters.payload.title` | `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L22) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderReturnValue.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderReturnValue.md deleted file mode 100644 index ab7e6bdade21ee..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderReturnValue.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BuilderReturnValue - -# Interface: BuilderReturnValue - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BuilderReturnValue - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.BuilderReturnValue.md#attributes) -- [references](client._internal_namespace.BuilderReturnValue.md#references) - -## Properties - -### attributes - -• **attributes**: [`Attributes`](client._internal_namespace.Attributes.md) - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:93](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L93) - -___ - -### references - -• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:94](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L94) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md deleted file mode 100644 index ac16ce838e615a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md +++ /dev/null @@ -1,125 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BulkCreateAttachmentDeletionUserAction - -# Interface: BulkCreateAttachmentDeletionUserAction - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BulkCreateAttachmentDeletionUserAction - -## Hierarchy - -- `Omit`<[`CommonUserActionArgs`](../modules/client._internal_namespace.md#commonuseractionargs), ``"owner"``\> - - ↳ **`BulkCreateAttachmentDeletionUserAction`** - -## Table of contents - -### Properties - -- [action](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#action) -- [attachmentId](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#attachmentid) -- [attachments](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#attachments) -- [caseId](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#caseid) -- [connectorId](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#connectorid) -- [unsecuredSavedObjectsClient](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#unsecuredsavedobjectsclient) -- [user](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#user) - -## Properties - -### action - -• `Optional` **action**: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` - -#### Inherited from - -Omit.action - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L80) - -___ - -### attachmentId - -• `Optional` **attachmentId**: `string` - -#### Inherited from - -Omit.attachmentId - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L78) - -___ - -### attachments - -• **attachments**: { `attachment`: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } ; `id`: `string` ; `owner`: `string` }[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:95](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L95) - -___ - -### caseId - -• **caseId**: `string` - -#### Inherited from - -Omit.caseId - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:76](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L76) - -___ - -### connectorId - -• `Optional` **connectorId**: `string` - -#### Inherited from - -Omit.connectorId - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L79) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -Omit.unsecuredSavedObjectsClient - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) - -___ - -### user - -• **user**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Inherited from - -Omit.user - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L75) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md deleted file mode 100644 index 5acc559d72638a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md +++ /dev/null @@ -1,72 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BulkCreateBulkUpdateCaseUserActions - -# Interface: BulkCreateBulkUpdateCaseUserActions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BulkCreateBulkUpdateCaseUserActions - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`BulkCreateBulkUpdateCaseUserActions`** - -## Table of contents - -### Properties - -- [originalCases](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md#originalcases) -- [unsecuredSavedObjectsClient](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md#unsecuredsavedobjectsclient) -- [updatedCases](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md#updatedcases) -- [user](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md#user) - -## Properties - -### originalCases - -• **originalCases**: [`SavedObject`](client._internal_namespace.SavedObject.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:89](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L89) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) - -___ - -### updatedCases - -• **updatedCases**: [`SavedObjectsUpdateResponse`](client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:90](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L90) - -___ - -### user - -• **user**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:91](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L91) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md deleted file mode 100644 index d925395547e550..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md +++ /dev/null @@ -1,61 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BulkCreateCaseDeletionUserAction - -# Interface: BulkCreateCaseDeletionUserAction - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BulkCreateCaseDeletionUserAction - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`BulkCreateCaseDeletionUserAction`** - -## Table of contents - -### Properties - -- [cases](client._internal_namespace.BulkCreateCaseDeletionUserAction.md#cases) -- [unsecuredSavedObjectsClient](client._internal_namespace.BulkCreateCaseDeletionUserAction.md#unsecuredsavedobjectsclient) -- [user](client._internal_namespace.BulkCreateCaseDeletionUserAction.md#user) - -## Properties - -### cases - -• **cases**: { `connectorId`: `string` ; `id`: `string` ; `owner`: `string` }[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L78) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) - -___ - -### user - -• **user**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L79) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md deleted file mode 100644 index ecaf5f4b535f79..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BulkUpdateAttachmentArgs - -# Interface: BulkUpdateAttachmentArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BulkUpdateAttachmentArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`BulkUpdateAttachmentArgs`** - -## Table of contents - -### Properties - -- [comments](client._internal_namespace.BulkUpdateAttachmentArgs.md#comments) -- [unsecuredSavedObjectsClient](client._internal_namespace.BulkUpdateAttachmentArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### comments - -• **comments**: [`UpdateArgs`](client._internal_namespace.UpdateArgs.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:62](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L62) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CancellableTask.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CancellableTask.md deleted file mode 100644 index f7a64576954007..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CancellableTask.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CancellableTask - -# Interface: CancellableTask - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CancellableTask - -## Table of contents - -### Properties - -- [cancel](client._internal_namespace.CancellableTask.md#cancel) -- [run](client._internal_namespace.CancellableTask.md#run) - -## Properties - -### cancel - -• `Optional` **cancel**: [`CancelFunction`](../modules/client._internal_namespace.md#cancelfunction) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:68 - -___ - -### run - -• **run**: [`RunFunction`](../modules/client._internal_namespace.md#runfunction) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:67 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Capabilities.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Capabilities.md deleted file mode 100644 index b9cddb8df9faf5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Capabilities.md +++ /dev/null @@ -1,63 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Capabilities - -# Interface: Capabilities - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Capabilities - -The read-only set of capabilities available for the current UI session. -Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, -and the boolean is a flag indicating if the capability is enabled or disabled. - -## Indexable - -▪ [key: `string`]: `Record`<`string`, `boolean` \| `Record`<`string`, `boolean`\>\> - -Custom capabilities, registered by plugins. - -## Table of contents - -### Properties - -- [catalogue](client._internal_namespace.Capabilities.md#catalogue) -- [management](client._internal_namespace.Capabilities.md#management) -- [navLinks](client._internal_namespace.Capabilities.md#navlinks) - -## Properties - -### catalogue - -• **catalogue**: `Record`<`string`, `boolean`\> - -Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. - -#### Defined in - -src/core/target/types/types/capabilities.d.ts:16 - -___ - -### management - -• **management**: `Object` - -Management section capabilities. - -#### Index signature - -▪ [sectionId: `string`]: `Record`<`string`, `boolean`\> - -#### Defined in - -src/core/target/types/types/capabilities.d.ts:12 - -___ - -### navLinks - -• **navLinks**: `Record`<`string`, `boolean`\> - -Navigation link capabilities. - -#### Defined in - -src/core/target/types/types/capabilities.d.ts:10 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CaseCommentStats.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CaseCommentStats.md deleted file mode 100644 index e4596ea3eacc17..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CaseCommentStats.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CaseCommentStats - -# Interface: CaseCommentStats - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CaseCommentStats - -## Table of contents - -### Properties - -- [alertTotals](client._internal_namespace.CaseCommentStats.md#alerttotals) -- [commentTotals](client._internal_namespace.CaseCommentStats.md#commenttotals) - -## Properties - -### alertTotals - -• **alertTotals**: `Map`<`string`, `number`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:115](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L115) - -___ - -### commentTotals - -• **commentTotals**: `Map`<`string`, `number`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:114](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L114) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesClientArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesClientArgs.md deleted file mode 100644 index 9ec38679b26d03..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesClientArgs.md +++ /dev/null @@ -1,160 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesClientArgs - -# Interface: CasesClientArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesClientArgs - -Parameters for initializing a cases client - -## Table of contents - -### Properties - -- [actionsClient](client._internal_namespace.CasesClientArgs.md#actionsclient) -- [alertsService](client._internal_namespace.CasesClientArgs.md#alertsservice) -- [attachmentService](client._internal_namespace.CasesClientArgs.md#attachmentservice) -- [authorization](client._internal_namespace.CasesClientArgs.md#authorization) -- [caseConfigureService](client._internal_namespace.CasesClientArgs.md#caseconfigureservice) -- [caseService](client._internal_namespace.CasesClientArgs.md#caseservice) -- [connectorMappingsService](client._internal_namespace.CasesClientArgs.md#connectormappingsservice) -- [lensEmbeddableFactory](client._internal_namespace.CasesClientArgs.md#lensembeddablefactory) -- [logger](client._internal_namespace.CasesClientArgs.md#logger) -- [unsecuredSavedObjectsClient](client._internal_namespace.CasesClientArgs.md#unsecuredsavedobjectsclient) -- [user](client._internal_namespace.CasesClientArgs.md#user) -- [userActionService](client._internal_namespace.CasesClientArgs.md#useractionservice) - -## Properties - -### actionsClient - -• `Readonly` **actionsClient**: `PublicMethodsOf`<[`ActionsClient`](../modules/client._internal_namespace.md#actionsclient)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:38](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L38) - -___ - -### alertsService - -• `Readonly` **alertsService**: [`AlertService`](../classes/client._internal_namespace.AlertService.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:33](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L33) - -___ - -### attachmentService - -• `Readonly` **attachmentService**: [`AttachmentService`](../classes/client._internal_namespace.AttachmentService.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L34) - -___ - -### authorization - -• `Readonly` **authorization**: `PublicMethodsOf`<[`Authorization`](../classes/client._internal_namespace.Authorization.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:37](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L37) - -___ - -### caseConfigureService - -• `Readonly` **caseConfigureService**: [`CaseConfigureService`](../classes/client._internal_namespace.CaseConfigureService.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:27](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L27) - -___ - -### caseService - -• `Readonly` **caseService**: [`CasesService`](../classes/client._internal_namespace.CasesService.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L28) - -___ - -### connectorMappingsService - -• `Readonly` **connectorMappingsService**: [`ConnectorMappingsService`](../classes/client._internal_namespace.ConnectorMappingsService.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L29) - -___ - -### lensEmbeddableFactory - -• `Readonly` **lensEmbeddableFactory**: () => [`EmbeddableRegistryDefinition`](client._internal_namespace.EmbeddableRegistryDefinition.md)<[`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype)\> - -#### Type declaration - -▸ (): [`EmbeddableRegistryDefinition`](client._internal_namespace.EmbeddableRegistryDefinition.md)<[`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype)\> - -##### Returns - -[`EmbeddableRegistryDefinition`](client._internal_namespace.EmbeddableRegistryDefinition.md)<[`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:36](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L36) - -___ - -### logger - -• `Readonly` **logger**: `Logger` - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L35) - -___ - -### unsecuredSavedObjectsClient - -• `Readonly` **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:31](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L31) - -___ - -### user - -• `Readonly` **user**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L30) - -___ - -### userActionService - -• `Readonly` **userActionService**: [`CaseUserActionService`](../classes/client._internal_namespace.CaseUserActionService.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/types.ts:32](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L32) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesMapWithPageInfo.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesMapWithPageInfo.md deleted file mode 100644 index a39f560b084af6..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesMapWithPageInfo.md +++ /dev/null @@ -1,54 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesMapWithPageInfo - -# Interface: CasesMapWithPageInfo - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesMapWithPageInfo - -## Table of contents - -### Properties - -- [casesMap](client._internal_namespace.CasesMapWithPageInfo.md#casesmap) -- [page](client._internal_namespace.CasesMapWithPageInfo.md#page) -- [perPage](client._internal_namespace.CasesMapWithPageInfo.md#perpage) -- [total](client._internal_namespace.CasesMapWithPageInfo.md#total) - -## Properties - -### casesMap - -• **casesMap**: `Map`<`string`, { `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `totalAlerts`: `number` = rt.number; `totalComment`: `number` = rt.number; `version`: `string` = rt.string } & { `comments`: `undefined` \| { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] }\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:119](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L119) - -___ - -### page - -• **page**: `number` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:120](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L120) - -___ - -### perPage - -• **perPage**: `number` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:121](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L121) - -___ - -### total - -• **total**: `number` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:122](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L122) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivileges.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivileges.md deleted file mode 100644 index 6cf7583198177d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivileges.md +++ /dev/null @@ -1,78 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CheckPrivileges - -# Interface: CheckPrivileges - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CheckPrivileges - -## Table of contents - -### Methods - -- [atSpace](client._internal_namespace.CheckPrivileges.md#atspace) -- [atSpaces](client._internal_namespace.CheckPrivileges.md#atspaces) -- [globally](client._internal_namespace.CheckPrivileges.md#globally) - -## Methods - -### atSpace - -▸ **atSpace**(`spaceId`, `privileges`, `options?`): `Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `spaceId` | `string` | -| `privileges` | [`CheckPrivilegesPayload`](client._internal_namespace.CheckPrivilegesPayload.md) | -| `options?` | [`CheckPrivilegesOptions`](client._internal_namespace.CheckPrivilegesOptions.md) | - -#### Returns - -`Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:61 - -___ - -### atSpaces - -▸ **atSpaces**(`spaceIds`, `privileges`, `options?`): `Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `spaceIds` | `string`[] | -| `privileges` | [`CheckPrivilegesPayload`](client._internal_namespace.CheckPrivilegesPayload.md) | -| `options?` | [`CheckPrivilegesOptions`](client._internal_namespace.CheckPrivilegesOptions.md) | - -#### Returns - -`Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:62 - -___ - -### globally - -▸ **globally**(`privileges`, `options?`): `Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privileges` | [`CheckPrivilegesPayload`](client._internal_namespace.CheckPrivilegesPayload.md) | -| `options?` | [`CheckPrivilegesOptions`](client._internal_namespace.CheckPrivilegesOptions.md) | - -#### Returns - -`Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:63 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesOptions.md deleted file mode 100644 index 85caefaa3b490d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CheckPrivilegesOptions - -# Interface: CheckPrivilegesOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CheckPrivilegesOptions - -Options to influce the privilege checks. - -## Table of contents - -### Properties - -- [requireLoginAction](client._internal_namespace.CheckPrivilegesOptions.md#requireloginaction) - -## Properties - -### requireLoginAction - -• `Optional` **requireLoginAction**: `boolean` - -Whether or not the `login` action should be required (default: true). -Setting this to false is not advised except for special circumstances, when you do not require -the request to belong to a user capable of logging into Kibana. - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:31 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesPayload.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesPayload.md deleted file mode 100644 index 29242fb43dbabf..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesPayload.md +++ /dev/null @@ -1,39 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CheckPrivilegesPayload - -# Interface: CheckPrivilegesPayload - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CheckPrivilegesPayload - -## Table of contents - -### Properties - -- [elasticsearch](client._internal_namespace.CheckPrivilegesPayload.md#elasticsearch) -- [kibana](client._internal_namespace.CheckPrivilegesPayload.md#kibana) - -## Properties - -### elasticsearch - -• `Optional` **elasticsearch**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `cluster` | `string`[] | -| `index` | `Record`<`string`, `string`[]\> | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:67 - -___ - -### kibana - -• `Optional` **kibana**: `string` \| `string`[] - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:66 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesResponse.md deleted file mode 100644 index 8e4ce4ae9c8150..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesResponse.md +++ /dev/null @@ -1,52 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CheckPrivilegesResponse - -# Interface: CheckPrivilegesResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CheckPrivilegesResponse - -## Table of contents - -### Properties - -- [hasAllRequested](client._internal_namespace.CheckPrivilegesResponse.md#hasallrequested) -- [privileges](client._internal_namespace.CheckPrivilegesResponse.md#privileges) -- [username](client._internal_namespace.CheckPrivilegesResponse.md#username) - -## Properties - -### hasAllRequested - -• **hasAllRequested**: `boolean` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:34 - -___ - -### privileges - -• **privileges**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `elasticsearch` | `Object` | -| `elasticsearch.cluster` | { `authorized`: `boolean` ; `privilege`: `string` }[] | -| `elasticsearch.index` | `Object` | -| `kibana` | { `authorized`: `boolean` ; `privilege`: `string` ; `resource?`: `string` }[] | - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:36 - -___ - -### username - -• **username**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:35 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-1.md deleted file mode 100644 index ded25fa2ce1059..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-1.md +++ /dev/null @@ -1,55 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ClientArgs - -# Interface: ClientArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ClientArgs - -## Hierarchy - -- **`ClientArgs`** - - ↳ [`GetCaseIdsByAlertIdArgs`](client._internal_namespace.GetCaseIdsByAlertIdArgs.md) - - ↳ [`GetCaseArgs`](client._internal_namespace.GetCaseArgs.md) - - ↳ [`GetCasesArgs`](client._internal_namespace.GetCasesArgs.md) - - ↳ [`FindCasesArgs`](client._internal_namespace.FindCasesArgs.md) - - ↳ [`PostCaseArgs`](client._internal_namespace.PostCaseArgs.md) - - ↳ [`PatchCasesArgs`](client._internal_namespace.PatchCasesArgs.md) - - ↳ [`BulkCreateCaseDeletionUserAction`](client._internal_namespace.BulkCreateCaseDeletionUserAction.md) - - ↳ [`BulkCreateBulkUpdateCaseUserActions`](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md) - - ↳ [`GetCaseUserActionArgs`](client._internal_namespace.GetCaseUserActionArgs.md) - - ↳ [`CreateUserActionES`](client._internal_namespace.CreateUserActionES.md) - - ↳ [`PostCaseUserActionArgs`](client._internal_namespace.PostCaseUserActionArgs.md) - - ↳ [`AttachedToCaseArgs`](client._internal_namespace.AttachedToCaseArgs.md) - - ↳ [`GetAttachmentArgs`](client._internal_namespace.GetAttachmentArgs.md) - - ↳ [`CreateAttachmentArgs`](client._internal_namespace.CreateAttachmentArgs.md) - - ↳ [`BulkUpdateAttachmentArgs`](client._internal_namespace.BulkUpdateAttachmentArgs.md) - -## Table of contents - -### Properties - -- [unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -## Properties - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-2.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-2.md deleted file mode 100644 index 78bc19f876c89f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-2.md +++ /dev/null @@ -1,31 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ClientArgs - -# Interface: ClientArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ClientArgs - -## Hierarchy - -- **`ClientArgs`** - - ↳ [`FindConnectorMappingsArgs`](client._internal_namespace.FindConnectorMappingsArgs.md) - - ↳ [`PostConnectorMappingsArgs`](client._internal_namespace.PostConnectorMappingsArgs.md) - - ↳ [`UpdateConnectorMappingsArgs`](client._internal_namespace.UpdateConnectorMappingsArgs.md) - -## Table of contents - -### Properties - -- [unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-2.md#unsecuredsavedobjectsclient) - -## Properties - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs.md deleted file mode 100644 index 9e5709a8b99baf..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs.md +++ /dev/null @@ -1,33 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ClientArgs - -# Interface: ClientArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ClientArgs - -## Hierarchy - -- **`ClientArgs`** - - ↳ [`GetCaseConfigureArgs`](client._internal_namespace.GetCaseConfigureArgs.md) - - ↳ [`FindCaseConfigureArgs`](client._internal_namespace.FindCaseConfigureArgs.md) - - ↳ [`PostCaseConfigureArgs`](client._internal_namespace.PostCaseConfigureArgs.md) - - ↳ [`PatchCaseConfigureArgs`](client._internal_namespace.PatchCaseConfigureArgs.md) - -## Table of contents - -### Properties - -- [unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CommonArguments.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CommonArguments.md deleted file mode 100644 index ed1bb0d81f42ad..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CommonArguments.md +++ /dev/null @@ -1,84 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CommonArguments - -# Interface: CommonArguments - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CommonArguments - -## Table of contents - -### Properties - -- [action](client._internal_namespace.CommonArguments.md#action) -- [attachmentId](client._internal_namespace.CommonArguments.md#attachmentid) -- [caseId](client._internal_namespace.CommonArguments.md#caseid) -- [connectorId](client._internal_namespace.CommonArguments.md#connectorid) -- [owner](client._internal_namespace.CommonArguments.md#owner) -- [user](client._internal_namespace.CommonArguments.md#user) - -## Properties - -### action - -• `Optional` **action**: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L80) - -___ - -### attachmentId - -• `Optional` **attachmentId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L78) - -___ - -### caseId - -• **caseId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:76](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L76) - -___ - -### connectorId - -• `Optional` **connectorId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L79) - -___ - -### owner - -• **owner**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L77) - -___ - -### user - -• **user**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L75) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConcreteTaskInstance.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConcreteTaskInstance.md deleted file mode 100644 index db3d362c3dbc34..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConcreteTaskInstance.md +++ /dev/null @@ -1,291 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConcreteTaskInstance - -# Interface: ConcreteTaskInstance - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConcreteTaskInstance - -A task instance that has an id and is ready for storage. - -## Hierarchy - -- [`TaskInstance`](client._internal_namespace.TaskInstance.md) - - ↳ **`ConcreteTaskInstance`** - -## Table of contents - -### Properties - -- [attempts](client._internal_namespace.ConcreteTaskInstance.md#attempts) -- [id](client._internal_namespace.ConcreteTaskInstance.md#id) -- [ownerId](client._internal_namespace.ConcreteTaskInstance.md#ownerid) -- [params](client._internal_namespace.ConcreteTaskInstance.md#params) -- [retryAt](client._internal_namespace.ConcreteTaskInstance.md#retryat) -- [runAt](client._internal_namespace.ConcreteTaskInstance.md#runat) -- [schedule](client._internal_namespace.ConcreteTaskInstance.md#schedule) -- [scheduledAt](client._internal_namespace.ConcreteTaskInstance.md#scheduledat) -- [scope](client._internal_namespace.ConcreteTaskInstance.md#scope) -- [startedAt](client._internal_namespace.ConcreteTaskInstance.md#startedat) -- [state](client._internal_namespace.ConcreteTaskInstance.md#state) -- [status](client._internal_namespace.ConcreteTaskInstance.md#status) -- [taskType](client._internal_namespace.ConcreteTaskInstance.md#tasktype) -- [traceparent](client._internal_namespace.ConcreteTaskInstance.md#traceparent) -- [user](client._internal_namespace.ConcreteTaskInstance.md#user) -- [version](client._internal_namespace.ConcreteTaskInstance.md#version) - -## Properties - -### attempts - -• **attempts**: `number` - -The number of unsuccessful attempts since the last successful run. This -will be zeroed out after a successful run. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:244 - -___ - -### id - -• **id**: `string` - -The id of the Elastic document that stores this instance's data. This can -be passed by the caller when scheduling the task. - -#### Overrides - -[TaskInstance](client._internal_namespace.TaskInstance.md).[id](client._internal_namespace.TaskInstance.md#id) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:230 - -___ - -### ownerId - -• **ownerId**: ``null`` \| `string` - -The random uuid of the Kibana instance which claimed ownership of the task last - -#### Overrides - -[TaskInstance](client._internal_namespace.TaskInstance.md).[ownerId](client._internal_namespace.TaskInstance.md#ownerid) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:274 - -___ - -### params - -• **params**: `Record`<`string`, `any`\> - -A task-specific set of parameters, used by the task's run function to tailor -its work. This is generally user-input, such as { sms: '333-444-2222' }. - -#### Inherited from - -[TaskInstance](client._internal_namespace.TaskInstance.md).[params](client._internal_namespace.TaskInstance.md#params) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:182 - -___ - -### retryAt - -• **retryAt**: ``null`` \| `Date` - -The date and time that this task should re-execute if stuck in "running" / timeout -status. This value is only set when status is set to "running". - -#### Overrides - -[TaskInstance](client._internal_namespace.TaskInstance.md).[retryAt](client._internal_namespace.TaskInstance.md#retryat) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:264 - -___ - -### runAt - -• **runAt**: `Date` - -The date and time that this task is scheduled to be run. It is not guaranteed -to run at this time, but it is guaranteed not to run earlier than this. - -#### Overrides - -[TaskInstance](client._internal_namespace.TaskInstance.md).[runAt](client._internal_namespace.TaskInstance.md#runat) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:253 - -___ - -### schedule - -• `Optional` **schedule**: [`IntervalSchedule`](client._internal_namespace.IntervalSchedule.md) - -A TaskSchedule string, which specifies this as a recurring task. - -Currently, this supports a single format: an interval in minutes or seconds (e.g. '5m', '30s'). - -#### Inherited from - -[TaskInstance](client._internal_namespace.TaskInstance.md).[schedule](client._internal_namespace.TaskInstance.md#schedule) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:177 - -___ - -### scheduledAt - -• **scheduledAt**: `Date` - -The date and time that this task was originally scheduled. This is used -for convenience to task run functions, and for troubleshooting. - -#### Overrides - -[TaskInstance](client._internal_namespace.TaskInstance.md).[scheduledAt](client._internal_namespace.TaskInstance.md#scheduledat) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:239 - -___ - -### scope - -• `Optional` **scope**: `string`[] - -Used to group tasks for querying. So, reporting might schedule tasks with a scope of 'reporting', -and then query such tasks to provide a glimpse at only reporting tasks, rather than at all tasks. - -#### Inherited from - -[TaskInstance](client._internal_namespace.TaskInstance.md).[scope](client._internal_namespace.TaskInstance.md#scope) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:201 - -___ - -### startedAt - -• **startedAt**: ``null`` \| `Date` - -The date and time that this task started execution. This is used to determine -the "real" runAt that ended up running the task. This value is only set -when status is set to "running". - -#### Overrides - -[TaskInstance](client._internal_namespace.TaskInstance.md).[startedAt](client._internal_namespace.TaskInstance.md#startedat) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:259 - -___ - -### state - -• **state**: `Record`<`string`, `any`\> - -The state passed into the task's run function, and returned by the previous -run. If there was no previous run, or if the previous run did not return -any state, this will be the empy object: {} - -#### Overrides - -[TaskInstance](client._internal_namespace.TaskInstance.md).[state](client._internal_namespace.TaskInstance.md#state) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:270 - -___ - -### status - -• **status**: [`TaskStatus`](../enums/client._internal_namespace.TaskStatus.md) - -Indicates whether or not the task is currently running. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:248 - -___ - -### taskType - -• **taskType**: `string` - -The task definition type whose run function will execute this instance. - -#### Inherited from - -[TaskInstance](client._internal_namespace.TaskInstance.md).[taskType](client._internal_namespace.TaskInstance.md#tasktype) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:149 - -___ - -### traceparent - -• `Optional` **traceparent**: `string` - -The serialized traceparent string of the current APM transaction or span. - -#### Inherited from - -[TaskInstance](client._internal_namespace.TaskInstance.md).[traceparent](client._internal_namespace.TaskInstance.md#traceparent) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:192 - -___ - -### user - -• `Optional` **user**: `string` - -The id of the user who scheduled this task. - -#### Inherited from - -[TaskInstance](client._internal_namespace.TaskInstance.md).[user](client._internal_namespace.TaskInstance.md#user) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:196 - -___ - -### version - -• `Optional` **version**: `string` - -The saved object version from the Elaticsearch document. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:234 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConnectorToken.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConnectorToken.md deleted file mode 100644 index c60e9bca79a7fa..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConnectorToken.md +++ /dev/null @@ -1,82 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConnectorToken - -# Interface: ConnectorToken - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConnectorToken - -## Hierarchy - -- [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) - - ↳ **`ConnectorToken`** - -## Table of contents - -### Properties - -- [connectorId](client._internal_namespace.ConnectorToken.md#connectorid) -- [createdAt](client._internal_namespace.ConnectorToken.md#createdat) -- [expiresAt](client._internal_namespace.ConnectorToken.md#expiresat) -- [token](client._internal_namespace.ConnectorToken.md#token) -- [tokenType](client._internal_namespace.ConnectorToken.md#tokentype) -- [updatedAt](client._internal_namespace.ConnectorToken.md#updatedat) - -## Properties - -### connectorId - -• **connectorId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:123 - -___ - -### createdAt - -• **createdAt**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:127 - -___ - -### expiresAt - -• **expiresAt**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:126 - -___ - -### token - -• **token**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:125 - -___ - -### tokenType - -• **tokenType**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:124 - -___ - -### updatedAt - -• `Optional` **updatedAt**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:128 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-1.md deleted file mode 100644 index 1f7901ac983f1d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-1.md +++ /dev/null @@ -1,60 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConstructorOptions - -# Interface: ConstructorOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConstructorOptions - -## Table of contents - -### Properties - -- [authentication](client._internal_namespace.ConstructorOptions-1.md#authentication) -- [authorization](client._internal_namespace.ConstructorOptions-1.md#authorization) -- [authorizationMode](client._internal_namespace.ConstructorOptions-1.md#authorizationmode) -- [request](client._internal_namespace.ConstructorOptions-1.md#request) - -## Properties - -### authentication - -• `Optional` **authentication**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `getCurrentUser` | (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\>) => ``null`` \| [`AuthenticatedUser`](client._internal_namespace.AuthenticatedUser.md) | - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:7 - -___ - -### authorization - -• `Optional` **authorization**: [`AuthorizationServiceSetup`](client._internal_namespace.AuthorizationServiceSetup.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:6 - -___ - -### authorizationMode - -• `Optional` **authorizationMode**: [`AuthorizationMode`](../enums/client._internal_namespace.AuthorizationMode.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:8 - -___ - -### request - -• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-2.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-2.md deleted file mode 100644 index fed308c0530490..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-2.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConstructorOptions - -# Interface: ConstructorOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConstructorOptions - -## Table of contents - -### Properties - -- [encryptedSavedObjectsClient](client._internal_namespace.ConstructorOptions-2.md#encryptedsavedobjectsclient) -- [logger](client._internal_namespace.ConstructorOptions-2.md#logger) -- [unsecuredSavedObjectsClient](client._internal_namespace.ConstructorOptions-2.md#unsecuredsavedobjectsclient) - -## Properties - -### encryptedSavedObjectsClient - -• **encryptedSavedObjectsClient**: [`EncryptedSavedObjectsClient`](client._internal_namespace.EncryptedSavedObjectsClient.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:6 - -___ - -### logger - -• **logger**: `Logger` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:8 - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:7 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions.md deleted file mode 100644 index 67923b89864f8b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions.md +++ /dev/null @@ -1,153 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConstructorOptions - -# Interface: ConstructorOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConstructorOptions - -## Table of contents - -### Properties - -- [actionExecutor](client._internal_namespace.ConstructorOptions.md#actionexecutor) -- [actionTypeRegistry](client._internal_namespace.ConstructorOptions.md#actiontyperegistry) -- [auditLogger](client._internal_namespace.ConstructorOptions.md#auditlogger) -- [authorization](client._internal_namespace.ConstructorOptions.md#authorization) -- [connectorTokenClient](client._internal_namespace.ConstructorOptions.md#connectortokenclient) -- [defaultKibanaIndex](client._internal_namespace.ConstructorOptions.md#defaultkibanaindex) -- [ephemeralExecutionEnqueuer](client._internal_namespace.ConstructorOptions.md#ephemeralexecutionenqueuer) -- [executionEnqueuer](client._internal_namespace.ConstructorOptions.md#executionenqueuer) -- [preconfiguredActions](client._internal_namespace.ConstructorOptions.md#preconfiguredactions) -- [request](client._internal_namespace.ConstructorOptions.md#request) -- [scopedClusterClient](client._internal_namespace.ConstructorOptions.md#scopedclusterclient) -- [unsecuredSavedObjectsClient](client._internal_namespace.ConstructorOptions.md#unsecuredsavedobjectsclient) -- [usageCounter](client._internal_namespace.ConstructorOptions.md#usagecounter) - -## Properties - -### actionExecutor - -• **actionExecutor**: [`ActionExecutorContract`](../modules/client._internal_namespace.md#actionexecutorcontract) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:30 - -___ - -### actionTypeRegistry - -• **actionTypeRegistry**: [`ActionTypeRegistry`](../classes/client._internal_namespace.ActionTypeRegistry.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:27 - -___ - -### auditLogger - -• `Optional` **auditLogger**: [`AuditLogger`](client._internal_namespace.AuditLogger.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:35 - -___ - -### authorization - -• **authorization**: [`ActionsAuthorization`](../classes/client._internal_namespace.ActionsAuthorization.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:34 - -___ - -### connectorTokenClient - -• **connectorTokenClient**: [`ConnectorTokenClientContract`](../modules/client._internal_namespace.md#connectortokenclientcontract) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:37 - -___ - -### defaultKibanaIndex - -• **defaultKibanaIndex**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:25 - -___ - -### ephemeralExecutionEnqueuer - -• **ephemeralExecutionEnqueuer**: [`ExecutionEnqueuer`](../modules/client._internal_namespace.md#executionenqueuer)<[`RunNowResult`](client._internal_namespace.RunNowResult.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:32 - -___ - -### executionEnqueuer - -• **executionEnqueuer**: [`ExecutionEnqueuer`](../modules/client._internal_namespace.md#executionenqueuer)<`void`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:31 - -___ - -### preconfiguredActions - -• **preconfiguredActions**: [`PreConfiguredAction`](client._internal_namespace.PreConfiguredAction.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets)\>[] - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:29 - -___ - -### request - -• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:33 - -___ - -### scopedClusterClient - -• **scopedClusterClient**: [`IScopedClusterClient`](client._internal_namespace.IScopedClusterClient.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:26 - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:28 - -___ - -### usageCounter - -• `Optional` **usageCounter**: [`IUsageCounter`](client._internal_namespace.IUsageCounter.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:36 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md deleted file mode 100644 index a71324b5543ffa..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md +++ /dev/null @@ -1,72 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CountActionsAttachedToCaseArgs - -# Interface: CountActionsAttachedToCaseArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CountActionsAttachedToCaseArgs - -## Hierarchy - -- [`AttachedToCaseArgs`](client._internal_namespace.AttachedToCaseArgs.md) - - ↳ **`CountActionsAttachedToCaseArgs`** - -## Table of contents - -### Properties - -- [aggregations](client._internal_namespace.CountActionsAttachedToCaseArgs.md#aggregations) -- [caseId](client._internal_namespace.CountActionsAttachedToCaseArgs.md#caseid) -- [filter](client._internal_namespace.CountActionsAttachedToCaseArgs.md#filter) -- [unsecuredSavedObjectsClient](client._internal_namespace.CountActionsAttachedToCaseArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### aggregations - -• **aggregations**: `Record`<`string`, `AggregationsAggregationContainer`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:40](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L40) - -___ - -### caseId - -• **caseId**: `string` - -#### Inherited from - -[AttachedToCaseArgs](client._internal_namespace.AttachedToCaseArgs.md).[caseId](client._internal_namespace.AttachedToCaseArgs.md#caseid) - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:33](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L33) - -___ - -### filter - -• `Optional` **filter**: `KueryNode` - -#### Inherited from - -[AttachedToCaseArgs](client._internal_namespace.AttachedToCaseArgs.md).[filter](client._internal_namespace.AttachedToCaseArgs.md#filter) - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L34) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[AttachedToCaseArgs](client._internal_namespace.AttachedToCaseArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.AttachedToCaseArgs.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAttachmentArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAttachmentArgs.md deleted file mode 100644 index 50030284f8fb60..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAttachmentArgs.md +++ /dev/null @@ -1,64 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateAttachmentArgs - -# Interface: CreateAttachmentArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateAttachmentArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`CreateAttachmentArgs`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.CreateAttachmentArgs.md#attributes) -- [id](client._internal_namespace.CreateAttachmentArgs.md#id) -- [references](client._internal_namespace.CreateAttachmentArgs.md#references) -- [unsecuredSavedObjectsClient](client._internal_namespace.CreateAttachmentArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### attributes - -• **attributes**: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:48](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L48) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:50](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L50) - -___ - -### references - -• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:49](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L49) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAuditMsgParams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAuditMsgParams.md deleted file mode 100644 index 30c4ab0076bf0a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAuditMsgParams.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateAuditMsgParams - -# Interface: CreateAuditMsgParams - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateAuditMsgParams - -## Table of contents - -### Properties - -- [entity](client._internal_namespace.CreateAuditMsgParams.md#entity) -- [error](client._internal_namespace.CreateAuditMsgParams.md#error) -- [operation](client._internal_namespace.CreateAuditMsgParams.md#operation) - -## Properties - -### entity - -• `Optional` **entity**: [`OwnerEntity`](client._internal_namespace.OwnerEntity.md) - -#### Defined in - -[x-pack/plugins/cases/server/authorization/audit_logger.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L15) - -___ - -### error - -• `Optional` **error**: `Error` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/audit_logger.ts:16](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L16) - -___ - -### operation - -• **operation**: [`OperationDetails`](client._internal_namespace.OperationDetails.md) - -#### Defined in - -[x-pack/plugins/cases/server/authorization/audit_logger.ts:14](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L14) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions-1.md deleted file mode 100644 index 77e84843801b59..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions-1.md +++ /dev/null @@ -1,54 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateOptions - -# Interface: CreateOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateOptions - -## Table of contents - -### Properties - -- [connectorId](client._internal_namespace.CreateOptions-1.md#connectorid) -- [expiresAtMillis](client._internal_namespace.CreateOptions-1.md#expiresatmillis) -- [token](client._internal_namespace.CreateOptions-1.md#token) -- [tokenType](client._internal_namespace.CreateOptions-1.md#tokentype) - -## Properties - -### connectorId - -• **connectorId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:11 - -___ - -### expiresAtMillis - -• **expiresAtMillis**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:13 - -___ - -### token - -• **token**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:12 - -___ - -### tokenType - -• `Optional` **tokenType**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:14 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions.md deleted file mode 100644 index 1070beb2f03041..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateOptions - -# Interface: CreateOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateOptions - -## Table of contents - -### Properties - -- [action](client._internal_namespace.CreateOptions.md#action) - -## Properties - -### action - -• **action**: [`Action`](client._internal_namespace.Action.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:22 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserAction.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserAction.md deleted file mode 100644 index 5211a50019caed..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserAction.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateUserAction - -# Interface: CreateUserAction - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateUserAction - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends keyof [`BuilderParameters`](client._internal_namespace.BuilderParameters.md) | - -## Table of contents - -### Properties - -- [payload](client._internal_namespace.CreateUserAction.md#payload) -- [type](client._internal_namespace.CreateUserAction.md#type) - -## Properties - -### payload - -• **payload**: [`BuilderParameters`](client._internal_namespace.BuilderParameters.md)[`T`][``"parameters"``][``"payload"``] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:68](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L68) - -___ - -### type - -• **type**: `T` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:67](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L67) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserActionES.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserActionES.md deleted file mode 100644 index efc0b67c18a3e8..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserActionES.md +++ /dev/null @@ -1,59 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateUserActionES - -# Interface: CreateUserActionES - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateUserActionES - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`CreateUserActionES`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.CreateUserActionES.md#attributes) -- [references](client._internal_namespace.CreateUserActionES.md#references) -- [unsecuredSavedObjectsClient](client._internal_namespace.CreateUserActionES.md#unsecuredsavedobjectsclient) - -## Properties - -### attributes - -• **attributes**: `T` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:71](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L71) - -___ - -### references - -• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:72](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L72) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.DecoratedError.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.DecoratedError.md deleted file mode 100644 index 77ef99caaf16a1..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.DecoratedError.md +++ /dev/null @@ -1,27 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / DecoratedError - -# Interface: DecoratedError - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).DecoratedError - -## Hierarchy - -- `Boom` - - ↳ **`DecoratedError`** - -## Table of contents - -### Properties - -- [[code]](client._internal_namespace.DecoratedError.md#[code]) - -## Properties - -### [code] - -• `Optional` **[code]**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/errors.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md deleted file mode 100644 index 373ba63e5c6591..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md +++ /dev/null @@ -1,94 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ElasticsearchFeatureConfig - -# Interface: ElasticsearchFeatureConfig - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ElasticsearchFeatureConfig - -Interface for registering an Elasticsearch feature. -Feature registration allows plugins to hide their applications based -on configured cluster or index privileges. - -## Table of contents - -### Properties - -- [catalogue](client._internal_namespace.ElasticsearchFeatureConfig.md#catalogue) -- [id](client._internal_namespace.ElasticsearchFeatureConfig.md#id) -- [management](client._internal_namespace.ElasticsearchFeatureConfig.md#management) -- [privileges](client._internal_namespace.ElasticsearchFeatureConfig.md#privileges) - -## Properties - -### catalogue - -• `Optional` **catalogue**: `string`[] - -If this feature includes a catalogue entry, you can specify them here to control visibility based on the current space. - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:34 - -___ - -### id - -• **id**: `string` - -Unique identifier for this feature. -This identifier is also used when generating UI Capabilities. - -**`see`** UICapabilities - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:15 - -___ - -### management - -• `Optional` **management**: `Object` - -Management sections associated with this feature. - -**`example`** -```ts - // Enables access to the "Advanced Settings" management page within the Kibana section - management: { - kibana: ['settings'] - } -``` - -#### Index signature - -▪ [sectionId: `string`]: `string`[] - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:27 - -___ - -### privileges - -• **privileges**: [`FeatureElasticsearchPrivileges`](client._internal_namespace.FeatureElasticsearchPrivileges.md)[] - -Feature privilege definition. Specify one or more privileges which grant access to this feature. -Users must satisfy all privileges in at least one of the defined sets of privileges in order to be granted access. - -**`example`** -```ts - [{ - requiredClusterPrivileges: ['monitor'], - requiredIndexPrivileges: { - ['metricbeat-*']: ['read', 'view_index_metadata'] - } - }] -``` - -**`see`** FeatureElasticsearchPrivileges - -#### Defined in - -x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:50 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md deleted file mode 100644 index 6a4eba88cc91d5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md +++ /dev/null @@ -1,157 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / EmbeddableRegistryDefinition - -# Interface: EmbeddableRegistryDefinition - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).EmbeddableRegistryDefinition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `P` | extends [`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype) = [`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype) | - -## Hierarchy - -- [`PersistableStateDefinition`](../modules/client._internal_namespace.md#persistablestatedefinition)<`P`\> - - ↳ **`EmbeddableRegistryDefinition`** - -## Table of contents - -### Properties - -- [id](client._internal_namespace.EmbeddableRegistryDefinition.md#id) -- [migrations](client._internal_namespace.EmbeddableRegistryDefinition.md#migrations) - -### Methods - -- [extract](client._internal_namespace.EmbeddableRegistryDefinition.md#extract) -- [inject](client._internal_namespace.EmbeddableRegistryDefinition.md#inject) -- [telemetry](client._internal_namespace.EmbeddableRegistryDefinition.md#telemetry) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -src/plugins/embeddable/target/types/server/types.d.ts:13 - -___ - -### migrations - -• `Optional` **migrations**: [`MigrateFunctionsObject`](../modules/client._internal_namespace.md#migratefunctionsobject) \| [`GetMigrationFunctionObjectFn`](../modules/client._internal_namespace.md#getmigrationfunctionobjectfn) - -A list of migration functions, which migrate the persistable state -serializable object to the next version. Migration functions should are -keyed by the Kibana version using semver, where the version indicates to -which version the state will be migrated to. - -#### Inherited from - -PersistableStateDefinition.migrations - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:75 - -## Methods - -### extract - -▸ `Optional` **extract**(`state`): `Object` - -A function which receives state and should return the state with references -extracted and an array of the extracted references. The default case could -simply return the same state with an empty array of references. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | `P` | The persistable state serializable state object. | - -#### Returns - -`Object` - -Persistable state object with references extracted and a list of - references. - -| Name | Type | -| :------ | :------ | -| `references` | [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] | -| `state` | `P` | - -#### Inherited from - -PersistableStateDefinition.extract - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:65 - -___ - -### inject - -▸ `Optional` **inject**(`state`, `references`): `P` - -A function which receives state and a list of references and should return -back the state with references injected. The default is an identity -function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | `P` | The persistable state serializable state object. | -| `references` | [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] | List of saved object references. | - -#### Returns - -`P` - -Persistable state object with references injected. - -#### Inherited from - -PersistableStateDefinition.inject - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:55 - -___ - -### telemetry - -▸ `Optional` **telemetry**(`state`, `stats`): `Record`<`string`, `any`\> - -Function which reports telemetry information. This function is essentially -a "reducer" - it receives the existing "stats" object and returns an -updated version of the "stats" object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | `P` | The persistable state serializable state object. | -| `stats` | `Record`<`string`, `any`\> | Stats object containing the stats which were already collected. This `stats` object shall not be mutated in-line. | - -#### Returns - -`Record`<`string`, `any`\> - -A new stats object augmented with new telemetry information. - -#### Inherited from - -PersistableStateDefinition.telemetry - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md deleted file mode 100644 index fff1cd9a9e369d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md +++ /dev/null @@ -1,39 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / EncryptedSavedObjectsClient - -# Interface: EncryptedSavedObjectsClient - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).EncryptedSavedObjectsClient - -## Table of contents - -### Methods - -- [getDecryptedAsInternalUser](client._internal_namespace.EncryptedSavedObjectsClient.md#getdecryptedasinternaluser) - -## Methods - -### getDecryptedAsInternalUser - -▸ **getDecryptedAsInternalUser**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `id` | `string` | -| `options?` | [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) | - -#### Returns - -`Promise`<[`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\>\> - -#### Defined in - -x-pack/plugins/encrypted_saved_objects/target/types/server/saved_objects/index.d.ts:18 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions-1.md deleted file mode 100644 index 4004d5c4847933..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions-1.md +++ /dev/null @@ -1,101 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ExecuteOptions - -# Interface: ExecuteOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ExecuteOptions - -## Hierarchy - -- `Pick`<[`ExecuteOptions`](client._internal_namespace.ExecuteOptions.md), ``"params"`` \| ``"source"``\> - - ↳ **`ExecuteOptions`** - -## Table of contents - -### Properties - -- [apiKey](client._internal_namespace.ExecuteOptions-1.md#apikey) -- [executionId](client._internal_namespace.ExecuteOptions-1.md#executionid) -- [id](client._internal_namespace.ExecuteOptions-1.md#id) -- [params](client._internal_namespace.ExecuteOptions-1.md#params) -- [relatedSavedObjects](client._internal_namespace.ExecuteOptions-1.md#relatedsavedobjects) -- [source](client._internal_namespace.ExecuteOptions-1.md#source) -- [spaceId](client._internal_namespace.ExecuteOptions-1.md#spaceid) - -## Properties - -### apiKey - -• **apiKey**: ``null`` \| `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:15 - -___ - -### executionId - -• **executionId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:16 - -___ - -### id - -• **id**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:13 - -___ - -### params - -• **params**: `Record`<`string`, `unknown`\> - -#### Inherited from - -Pick.params - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:28 - -___ - -### relatedSavedObjects - -• `Optional` **relatedSavedObjects**: `Readonly`<{ `namespace?`: `string` ; `typeId?`: `string` } & { `id`: `string` ; `type`: `string` }\>[] - -#### Defined in - -x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:17 - -___ - -### source - -• `Optional` **source**: [`ActionExecutionSource`](client._internal_namespace.ActionExecutionSource.md)<`unknown`\> - -#### Inherited from - -Pick.source - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:29 - -___ - -### spaceId - -• **spaceId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:14 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions.md deleted file mode 100644 index fb808b1afbbee3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions.md +++ /dev/null @@ -1,104 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ExecuteOptions - -# Interface: ExecuteOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ExecuteOptions - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Source` | `unknown` | - -## Table of contents - -### Properties - -- [actionId](client._internal_namespace.ExecuteOptions.md#actionid) -- [executionId](client._internal_namespace.ExecuteOptions.md#executionid) -- [isEphemeral](client._internal_namespace.ExecuteOptions.md#isephemeral) -- [params](client._internal_namespace.ExecuteOptions.md#params) -- [relatedSavedObjects](client._internal_namespace.ExecuteOptions.md#relatedsavedobjects) -- [request](client._internal_namespace.ExecuteOptions.md#request) -- [source](client._internal_namespace.ExecuteOptions.md#source) -- [taskInfo](client._internal_namespace.ExecuteOptions.md#taskinfo) - -## Properties - -### actionId - -• **actionId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:25 - -___ - -### executionId - -• `Optional` **executionId**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:31 - -___ - -### isEphemeral - -• `Optional` **isEphemeral**: `boolean` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:26 - -___ - -### params - -• **params**: `Record`<`string`, `unknown`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:28 - -___ - -### relatedSavedObjects - -• `Optional` **relatedSavedObjects**: `Readonly`<{ `namespace?`: `string` ; `typeId?`: `string` } & { `id`: `string` ; `type`: `string` }\>[] - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:32 - -___ - -### request - -• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:27 - -___ - -### source - -• `Optional` **source**: [`ActionExecutionSource`](client._internal_namespace.ActionExecutionSource.md)<`Source`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:29 - -___ - -### taskInfo - -• `Optional` **taskInfo**: [`TaskInfo`](client._internal_namespace.TaskInfo.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:30 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md deleted file mode 100644 index bb462c53412336..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md +++ /dev/null @@ -1,106 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FeatureElasticsearchPrivileges - -# Interface: FeatureElasticsearchPrivileges - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FeatureElasticsearchPrivileges - -Elasticsearch Feature privilege definition - -## Table of contents - -### Properties - -- [requiredClusterPrivileges](client._internal_namespace.FeatureElasticsearchPrivileges.md#requiredclusterprivileges) -- [requiredIndexPrivileges](client._internal_namespace.FeatureElasticsearchPrivileges.md#requiredindexprivileges) -- [requiredRoles](client._internal_namespace.FeatureElasticsearchPrivileges.md#requiredroles) -- [ui](client._internal_namespace.FeatureElasticsearchPrivileges.md#ui) - -## Properties - -### requiredClusterPrivileges - -• **requiredClusterPrivileges**: `string`[] - -A set of Elasticsearch cluster privileges which are required for this feature to be enabled. -See https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_elasticsearch_privileges.d.ts:10 - -___ - -### requiredIndexPrivileges - -• `Optional` **requiredIndexPrivileges**: `Object` - -A set of Elasticsearch index privileges which are required for this feature to be enabled, keyed on index name or pattern. -See https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html#privileges-list-indices - -**`example`** - -Requiring `read` access to `logstash-*` and `all` access to `foo-*` -```ts -feature.registerElasticsearchPrivilege({ - privileges: [{ - requiredIndexPrivileges: { - ['logstash-*']: ['read'], - ['foo-*]: ['all'] - } - }] -}) -``` - -#### Index signature - -▪ [indexName: `string`]: `string`[] - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_elasticsearch_privileges.d.ts:30 - -___ - -### requiredRoles - -• `Optional` **requiredRoles**: `string`[] - -A set of Elasticsearch roles which are required for this feature to be enabled. - -**`deprecated`** do not rely on hard-coded role names. - -This is relied on by the reporting feature, and should be removed once reporting -migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_elasticsearch_privileges.d.ts:41 - -___ - -### ui - -• **ui**: `string`[] - -A list of UI Capabilities that should be granted to users with this privilege. -These capabilities will automatically be namespaces within your feature id. - -**`example`** -```ts - { - ui: ['show', 'save'] - } - - This translates in the UI to the following (assuming a feature id of "foo"): - import { uiCapabilities } from 'ui/capabilities'; - - const canShowApp = uiCapabilities.foo.show; - const canSave = uiCapabilities.foo.save; -``` -Note: Since these are automatically namespaced, you are free to use generic names like "show" and "save". - -**`see`** UICapabilities - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_elasticsearch_privileges.d.ts:62 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureKibanaPrivileges.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureKibanaPrivileges.md deleted file mode 100644 index caf57a8ff8987a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureKibanaPrivileges.md +++ /dev/null @@ -1,246 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FeatureKibanaPrivileges - -# Interface: FeatureKibanaPrivileges - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FeatureKibanaPrivileges - -Feature privilege definition - -## Table of contents - -### Properties - -- [alerting](client._internal_namespace.FeatureKibanaPrivileges.md#alerting) -- [api](client._internal_namespace.FeatureKibanaPrivileges.md#api) -- [app](client._internal_namespace.FeatureKibanaPrivileges.md#app) -- [cases](client._internal_namespace.FeatureKibanaPrivileges.md#cases) -- [catalogue](client._internal_namespace.FeatureKibanaPrivileges.md#catalogue) -- [disabled](client._internal_namespace.FeatureKibanaPrivileges.md#disabled) -- [excludeFromBasePrivileges](client._internal_namespace.FeatureKibanaPrivileges.md#excludefrombaseprivileges) -- [management](client._internal_namespace.FeatureKibanaPrivileges.md#management) -- [requireAllSpaces](client._internal_namespace.FeatureKibanaPrivileges.md#requireallspaces) -- [savedObject](client._internal_namespace.FeatureKibanaPrivileges.md#savedobject) -- [ui](client._internal_namespace.FeatureKibanaPrivileges.md#ui) - -## Properties - -### alerting - -• `Optional` **alerting**: `Object` - -If your feature requires access to specific Alert Types, then specify your access needs here. -Include both Alert Types registered by the feature and external Alert Types such as built-in -Alert Types and Alert Types provided by other features to which you wish to grant access. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `alert?` | `Object` | -| `alert.all?` | readonly `string`[] | -| `alert.read?` | readonly `string`[] | -| `rule?` | `Object` | -| `rule.all?` | readonly `string`[] | -| `rule.read?` | readonly `string`[] | - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:82 - -___ - -### api - -• `Optional` **api**: readonly `string`[] - -If your feature includes server-side APIs, you can tag those routes to secure access based on user permissions. - -**`example`** -```ts - // Configure your routes with a tag starting with the 'access:' prefix - server.route({ - path: '/api/my-route', - method: 'GET', - handler: () => { ...}, - options: { - tags: ['access:my_feature-admin'] - } - }); - - Then, specify the tags here (without the 'access:' prefix) which should be secured: - - { - api: ['my_feature-admin'] - } -``` - -NOTE: It is important to name your tags in a way that will not collide with other plugins/features. -A generic tag name like "access:read" could be used elsewhere, and access to that API endpoint would also -extend to any routes you have also tagged with that name. - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:64 - -___ - -### app - -• `Optional` **app**: readonly `string`[] - -If your feature exposes a client-side application (most of them do!), then you can control access to them here. - -**`example`** -```ts - { - app: ['my-app', 'kibana'] - } -``` - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:76 - -___ - -### cases - -• `Optional` **cases**: `Object` - -If your feature requires access to specific owners of cases (aka plugins that have created cases), then specify your access needs here. The values here should -be unique identifiers for the owners of cases you want access to. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `all?` | readonly `string`[] | List of case owners which users should have full read/write access to when granted this privilege. **`example`** ```ts { all: ['securitySolution'] } ``` | -| `read?` | readonly `string`[] | List of case owners which users should have read-only access to when granted this privilege. **`example`** ```ts { read: ['securitySolution'] } ``` | - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:132 - -___ - -### catalogue - -• `Optional` **catalogue**: readonly `string`[] - -If this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions. - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:37 - -___ - -### disabled - -• `Optional` **disabled**: `boolean` - -Whether or not this privilege should be hidden in the roles UI and disallowed on the API. Defaults to `false`. - -**`deprecated`** - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:18 - -___ - -### excludeFromBasePrivileges - -• `Optional` **excludeFromBasePrivileges**: `boolean` - -Whether or not this specific privilege should be excluded from the base privileges. - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:8 - -___ - -### management - -• `Optional` **management**: `Object` - -If this feature includes management sections, you can specify them here to control visibility of those -pages based on user privileges. - -**`example`** -```ts - // Enables access to the "Advanced Settings" management page within the Kibana section - management: { - kibana: ['settings'] - } -``` - -#### Index signature - -▪ [sectionId: `string`]: readonly `string`[] - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:31 - -___ - -### requireAllSpaces - -• `Optional` **requireAllSpaces**: `boolean` - -Whether or not this privilege should only be granted to `All Spaces *`. Should be used for features that do not -support Spaces. Defaults to `false`. - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:13 - -___ - -### savedObject - -• **savedObject**: `Object` - -If your feature requires access to specific saved objects, then specify your access needs here. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `all` | readonly `string`[] | List of saved object types which users should have full read/write access to when granted this privilege. **`example`** ```ts { all: ['my-saved-object-type'] } ``` | -| `read` | readonly `string`[] | List of saved object types which users should have read-only access to when granted this privilege. **`example`** ```ts { read: ['config'] } ``` | - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:157 - -___ - -### ui - -• **ui**: readonly `string`[] - -A list of UI Capabilities that should be granted to users with this privilege. -These capabilities will automatically be namespaces within your feature id. - -**`example`** -```ts - { - ui: ['show', 'save'] - } - - This translates in the UI to the following (assuming a feature id of "foo"): - import { uiCapabilities } from 'ui/capabilities'; - - const canShowApp = uiCapabilities.foo.show; - const canSave = uiCapabilities.foo.save; -``` -Note: Since these are automatically namespaced, you are free to use generic names like "show" and "save". - -**`see`** UICapabilities - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:199 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureUsageServiceSetup.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureUsageServiceSetup.md deleted file mode 100644 index 77770e22b41e20..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureUsageServiceSetup.md +++ /dev/null @@ -1,34 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FeatureUsageServiceSetup - -# Interface: FeatureUsageServiceSetup - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FeatureUsageServiceSetup - -## Table of contents - -### Methods - -- [register](client._internal_namespace.FeatureUsageServiceSetup.md#register) - -## Methods - -### register - -▸ **register**(`featureName`, `licenseType`): `void` - -Register a feature to be able to notify of it's usages using the {@link FeatureUsageServiceStart | service start contract}. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `featureName` | `string` | -| `licenseType` | ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/licensing/target/types/server/services/feature_usage_service.d.ts:7 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindActionResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindActionResult.md deleted file mode 100644 index e7306b5d7b9313..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindActionResult.md +++ /dev/null @@ -1,117 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindActionResult - -# Interface: FindActionResult - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindActionResult - -## Hierarchy - -- [`ActionResult`](client._internal_namespace.ActionResult.md) - - ↳ **`FindActionResult`** - -## Table of contents - -### Properties - -- [actionTypeId](client._internal_namespace.FindActionResult.md#actiontypeid) -- [config](client._internal_namespace.FindActionResult.md#config) -- [id](client._internal_namespace.FindActionResult.md#id) -- [isMissingSecrets](client._internal_namespace.FindActionResult.md#ismissingsecrets) -- [isPreconfigured](client._internal_namespace.FindActionResult.md#ispreconfigured) -- [name](client._internal_namespace.FindActionResult.md#name) -- [referencedByCount](client._internal_namespace.FindActionResult.md#referencedbycount) - -## Properties - -### actionTypeId - -• **actionTypeId**: `string` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[actionTypeId](client._internal_namespace.ActionResult.md#actiontypeid) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:50 - -___ - -### config - -• `Optional` **config**: [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[config](client._internal_namespace.ActionResult.md#config) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:53 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[id](client._internal_namespace.ActionResult.md#id) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:49 - -___ - -### isMissingSecrets - -• `Optional` **isMissingSecrets**: `boolean` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[isMissingSecrets](client._internal_namespace.ActionResult.md#ismissingsecrets) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:52 - -___ - -### isPreconfigured - -• **isPreconfigured**: `boolean` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[isPreconfigured](client._internal_namespace.ActionResult.md#ispreconfigured) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:54 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[name](client._internal_namespace.ActionResult.md#name) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:51 - -___ - -### referencedByCount - -• **referencedByCount**: `number` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:60 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseCommentsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseCommentsArgs.md deleted file mode 100644 index a5b1689fc0e9b2..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseCommentsArgs.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindCaseCommentsArgs - -# Interface: FindCaseCommentsArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindCaseCommentsArgs - -## Table of contents - -### Properties - -- [id](client._internal_namespace.FindCaseCommentsArgs.md#id) -- [options](client._internal_namespace.FindCaseCommentsArgs.md#options) -- [unsecuredSavedObjectsClient](client._internal_namespace.FindCaseCommentsArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### id - -• **id**: `string` \| `string`[] - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:84](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L84) - -___ - -### options - -• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L85) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:83](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L83) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseConfigureArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseConfigureArgs.md deleted file mode 100644 index 5e3635fe0c3ec6..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseConfigureArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindCaseConfigureArgs - -# Interface: FindCaseConfigureArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindCaseConfigureArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs.md) - - ↳ **`FindCaseConfigureArgs`** - -## Table of contents - -### Properties - -- [options](client._internal_namespace.FindCaseConfigureArgs.md#options) -- [unsecuredSavedObjectsClient](client._internal_namespace.FindCaseConfigureArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### options - -• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:37](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L37) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCasesArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCasesArgs.md deleted file mode 100644 index 0ac807ecaadace..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCasesArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindCasesArgs - -# Interface: FindCasesArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindCasesArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`FindCasesArgs`** - -## Table of contents - -### Properties - -- [options](client._internal_namespace.FindCasesArgs.md#options) -- [unsecuredSavedObjectsClient](client._internal_namespace.FindCasesArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### options - -• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:89](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L89) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCommentsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCommentsArgs.md deleted file mode 100644 index b88437b3e33a8b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCommentsArgs.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindCommentsArgs - -# Interface: FindCommentsArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindCommentsArgs - -## Table of contents - -### Properties - -- [id](client._internal_namespace.FindCommentsArgs.md#id) -- [options](client._internal_namespace.FindCommentsArgs.md#options) -- [unsecuredSavedObjectsClient](client._internal_namespace.FindCommentsArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### id - -• **id**: `string` \| `string`[] - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L78) - -___ - -### options - -• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L79) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L77) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindConnectorMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindConnectorMappingsArgs.md deleted file mode 100644 index 5f70d4ae539e8b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindConnectorMappingsArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindConnectorMappingsArgs - -# Interface: FindConnectorMappingsArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindConnectorMappingsArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-2.md) - - ↳ **`FindConnectorMappingsArgs`** - -## Table of contents - -### Properties - -- [options](client._internal_namespace.FindConnectorMappingsArgs.md#options) -- [unsecuredSavedObjectsClient](client._internal_namespace.FindConnectorMappingsArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### options - -• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:18](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L18) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-2.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-2.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAllSpacesOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAllSpacesOptions.md deleted file mode 100644 index 905d61791cb2ee..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAllSpacesOptions.md +++ /dev/null @@ -1,44 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetAllSpacesOptions - -# Interface: GetAllSpacesOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetAllSpacesOptions - -Controls how spaces are retrieved. - -## Table of contents - -### Properties - -- [includeAuthorizedPurposes](client._internal_namespace.GetAllSpacesOptions.md#includeauthorizedpurposes) -- [purpose](client._internal_namespace.GetAllSpacesOptions.md#purpose) - -## Properties - -### includeAuthorizedPurposes - -• `Optional` **includeAuthorizedPurposes**: `boolean` - -Set to true to return a set of flags indicating which purposes the user is authorized for. - -**`see`** GetAllSpacesPurpose - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:65 - -___ - -### purpose - -• `Optional` **purpose**: [`GetAllSpacesPurpose`](../modules/client._internal_namespace.md#getallspacespurpose) - -An optional purpose describing how the set of spaces will be used. -The default purpose (`any`) will retrieve all spaces the user is authorized to see, -whereas a more specific purpose will retrieve all spaces the user is authorized to perform a specific action within. - -**`see`** GetAllSpacesPurpose - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:59 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAttachmentArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAttachmentArgs.md deleted file mode 100644 index 39f6f288c84c54..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAttachmentArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetAttachmentArgs - -# Interface: GetAttachmentArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetAttachmentArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`GetAttachmentArgs`** - -## Table of contents - -### Properties - -- [attachmentId](client._internal_namespace.GetAttachmentArgs.md#attachmentid) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetAttachmentArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### attachmentId - -• **attachmentId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:44](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L44) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseArgs.md deleted file mode 100644 index 5cca6876f1821e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCaseArgs - -# Interface: GetCaseArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCaseArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`GetCaseArgs`** - -## Table of contents - -### Properties - -- [id](client._internal_namespace.GetCaseArgs.md#id) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetCaseArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:69](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L69) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseConfigureArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseConfigureArgs.md deleted file mode 100644 index 2aa37a7bf78a91..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseConfigureArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCaseConfigureArgs - -# Interface: GetCaseConfigureArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCaseConfigureArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs.md) - - ↳ **`GetCaseConfigureArgs`** - -## Table of contents - -### Properties - -- [configurationId](client._internal_namespace.GetCaseConfigureArgs.md#configurationid) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetCaseConfigureArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### configurationId - -• **configurationId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L34) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md deleted file mode 100644 index 267aa4fe7100ae..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md +++ /dev/null @@ -1,53 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCaseIdsByAlertIdArgs - -# Interface: GetCaseIdsByAlertIdArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCaseIdsByAlertIdArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`GetCaseIdsByAlertIdArgs`** - -## Table of contents - -### Properties - -- [alertId](client._internal_namespace.GetCaseIdsByAlertIdArgs.md#alertid) -- [filter](client._internal_namespace.GetCaseIdsByAlertIdArgs.md#filter) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetCaseIdsByAlertIdArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### alertId - -• **alertId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:59](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L59) - -___ - -### filter - -• `Optional` **filter**: `KueryNode` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:60](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L60) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseUserActionArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseUserActionArgs.md deleted file mode 100644 index 08edac1f82b2cf..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseUserActionArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCaseUserActionArgs - -# Interface: GetCaseUserActionArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCaseUserActionArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`GetCaseUserActionArgs`** - -## Table of contents - -### Properties - -- [caseId](client._internal_namespace.GetCaseUserActionArgs.md#caseid) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetCaseUserActionArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### caseId - -• **caseId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:58](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L58) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCasesArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCasesArgs.md deleted file mode 100644 index d5e802e19b9c00..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCasesArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCasesArgs - -# Interface: GetCasesArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCasesArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`GetCasesArgs`** - -## Table of contents - -### Properties - -- [caseIds](client._internal_namespace.GetCasesArgs.md#caseids) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetCasesArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### caseIds - -• **caseIds**: `string`[] - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:73](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L73) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetReportersArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetReportersArgs.md deleted file mode 100644 index af1116f4c3ddb0..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetReportersArgs.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetReportersArgs - -# Interface: GetReportersArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetReportersArgs - -## Table of contents - -### Properties - -- [filter](client._internal_namespace.GetReportersArgs.md#filter) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetReportersArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### filter - -• `Optional` **filter**: `KueryNode` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:134](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L134) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:133](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L133) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetSpaceResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetSpaceResult.md deleted file mode 100644 index 8e4162988105ee..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetSpaceResult.md +++ /dev/null @@ -1,176 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetSpaceResult - -# Interface: GetSpaceResult - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetSpaceResult - -Response format when querying for spaces. - -## Hierarchy - -- [`Space`](client._internal_namespace.Space.md) - - ↳ **`GetSpaceResult`** - -## Table of contents - -### Properties - -- [\_reserved](client._internal_namespace.GetSpaceResult.md#_reserved) -- [authorizedPurposes](client._internal_namespace.GetSpaceResult.md#authorizedpurposes) -- [color](client._internal_namespace.GetSpaceResult.md#color) -- [description](client._internal_namespace.GetSpaceResult.md#description) -- [disabledFeatures](client._internal_namespace.GetSpaceResult.md#disabledfeatures) -- [id](client._internal_namespace.GetSpaceResult.md#id) -- [imageUrl](client._internal_namespace.GetSpaceResult.md#imageurl) -- [initials](client._internal_namespace.GetSpaceResult.md#initials) -- [name](client._internal_namespace.GetSpaceResult.md#name) - -## Properties - -### \_reserved - -• `Optional` `Private` **\_reserved**: `boolean` - -Indicates that this space is reserved (system controlled). -Reserved spaces cannot be created or deleted by end-users. - -#### Inherited from - -[Space](client._internal_namespace.Space.md).[_reserved](client._internal_namespace.Space.md#_reserved) - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:46 - -___ - -### authorizedPurposes - -• `Optional` **authorizedPurposes**: `Record`<[`GetAllSpacesPurpose`](../modules/client._internal_namespace.md#getallspacespurpose), `boolean`\> - -A set of flags indicating which purposes the user is authorized for. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:82 - -___ - -### color - -• `Optional` **color**: `string` - -Optional color (hex code) for this space. -If neither `color` nor `imageUrl` is specified, then a color will be automatically generated. - -#### Inherited from - -[Space](client._internal_namespace.Space.md).[color](client._internal_namespace.Space.md#color) - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:24 - -___ - -### description - -• `Optional` **description**: `string` - -Optional description for this space. - -#### Inherited from - -[Space](client._internal_namespace.Space.md).[description](client._internal_namespace.Space.md#description) - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:19 - -___ - -### disabledFeatures - -• **disabledFeatures**: `string`[] - -The set of feature ids that should be hidden within this space. - -#### Inherited from - -[Space](client._internal_namespace.Space.md).[disabledFeatures](client._internal_namespace.Space.md#disabledfeatures) - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:40 - -___ - -### id - -• **id**: `string` - -The unique identifier for this space. -The id becomes part of the "URL Identifier" of the space. - -Example: an id of `marketing` would result in the URL identifier of `/s/marketing`. - -#### Inherited from - -[Space](client._internal_namespace.Space.md).[id](client._internal_namespace.Space.md#id) - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:11 - -___ - -### imageUrl - -• `Optional` **imageUrl**: `string` - -Optional base-64 encoded data image url to show as this space's avatar. -This setting takes precedence over any configured `color` or `initials`. - -#### Inherited from - -[Space](client._internal_namespace.Space.md).[imageUrl](client._internal_namespace.Space.md#imageurl) - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:36 - -___ - -### initials - -• `Optional` **initials**: `string` - -Optional display initials for this space's avatar. Supports a maximum of 2 characters. -If initials are not provided, then they will be derived from the space name automatically. - -Initials are not displayed if an `imageUrl` has been specified. - -#### Inherited from - -[Space](client._internal_namespace.Space.md).[initials](client._internal_namespace.Space.md#initials) - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:31 - -___ - -### name - -• **name**: `string` - -Display name for this space. - -#### Inherited from - -[Space](client._internal_namespace.Space.md).[name](client._internal_namespace.Space.md#name) - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:15 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetTagsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetTagsArgs.md deleted file mode 100644 index 31088513fe67fb..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetTagsArgs.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetTagsArgs - -# Interface: GetTagsArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetTagsArgs - -## Table of contents - -### Properties - -- [filter](client._internal_namespace.GetTagsArgs.md#filter) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetTagsArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### filter - -• `Optional` **filter**: `KueryNode` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:129](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L129) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:128](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L128) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserActionItemByDifference.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserActionItemByDifference.md deleted file mode 100644 index 50f9ae9a6fc343..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserActionItemByDifference.md +++ /dev/null @@ -1,162 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetUserActionItemByDifference - -# Interface: GetUserActionItemByDifference - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetUserActionItemByDifference - -## Hierarchy - -- [`CommonUserActionArgs`](../modules/client._internal_namespace.md#commonuseractionargs) - - ↳ **`GetUserActionItemByDifference`** - -## Table of contents - -### Properties - -- [action](client._internal_namespace.GetUserActionItemByDifference.md#action) -- [attachmentId](client._internal_namespace.GetUserActionItemByDifference.md#attachmentid) -- [caseId](client._internal_namespace.GetUserActionItemByDifference.md#caseid) -- [connectorId](client._internal_namespace.GetUserActionItemByDifference.md#connectorid) -- [field](client._internal_namespace.GetUserActionItemByDifference.md#field) -- [newValue](client._internal_namespace.GetUserActionItemByDifference.md#newvalue) -- [originalValue](client._internal_namespace.GetUserActionItemByDifference.md#originalvalue) -- [owner](client._internal_namespace.GetUserActionItemByDifference.md#owner) -- [unsecuredSavedObjectsClient](client._internal_namespace.GetUserActionItemByDifference.md#unsecuredsavedobjectsclient) -- [user](client._internal_namespace.GetUserActionItemByDifference.md#user) - -## Properties - -### action - -• `Optional` **action**: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` - -#### Inherited from - -CommonUserActionArgs.action - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L80) - -___ - -### attachmentId - -• `Optional` **attachmentId**: `string` - -#### Inherited from - -CommonUserActionArgs.attachmentId - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L78) - -___ - -### caseId - -• **caseId**: `string` - -#### Inherited from - -CommonUserActionArgs.caseId - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:76](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L76) - -___ - -### connectorId - -• `Optional` **connectorId**: `string` - -#### Inherited from - -CommonUserActionArgs.connectorId - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L79) - -___ - -### field - -• **field**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:83](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L83) - -___ - -### newValue - -• **newValue**: `unknown` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L85) - -___ - -### originalValue - -• **originalValue**: `unknown` - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:84](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L84) - -___ - -### owner - -• **owner**: `string` - -#### Inherited from - -CommonUserActionArgs.owner - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L77) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -CommonUserActionArgs.unsecuredSavedObjectsClient - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) - -___ - -### user - -• **user**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Inherited from - -CommonUserActionArgs.user - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L75) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserArgs.md deleted file mode 100644 index d4913925ff2069..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserArgs.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetUserArgs - -# Interface: GetUserArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetUserArgs - -## Table of contents - -### Properties - -- [request](client._internal_namespace.GetUserArgs.md#request) - -## Properties - -### request - -• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:110](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L110) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IEventLogger.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IEventLogger.md deleted file mode 100644 index a1b44e51859d4c..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IEventLogger.md +++ /dev/null @@ -1,73 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IEventLogger - -# Interface: IEventLogger - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IEventLogger - -## Table of contents - -### Methods - -- [logEvent](client._internal_namespace.IEventLogger.md#logevent) -- [startTiming](client._internal_namespace.IEventLogger.md#starttiming) -- [stopTiming](client._internal_namespace.IEventLogger.md#stoptiming) - -## Methods - -### logEvent - -▸ **logEvent**(`properties`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `properties` | [`IEvent`](../modules/client._internal_namespace.md#ievent) | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/event_log/target/types/server/types.d.ts:34 - -___ - -### startTiming - -▸ **startTiming**(`event`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`IEvent`](../modules/client._internal_namespace.md#ievent) | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/event_log/target/types/server/types.d.ts:35 - -___ - -### stopTiming - -▸ **stopTiming**(`event`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`IEvent`](../modules/client._internal_namespace.md#ievent) | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/event_log/target/types/server/types.d.ts:36 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IKibanaSocket.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IKibanaSocket.md deleted file mode 100644 index cc2ea54f3975aa..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IKibanaSocket.md +++ /dev/null @@ -1,150 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IKibanaSocket - -# Interface: IKibanaSocket - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IKibanaSocket - -A tiny abstraction for TCP socket. - -## Table of contents - -### Properties - -- [authorizationError](client._internal_namespace.IKibanaSocket.md#authorizationerror) -- [authorized](client._internal_namespace.IKibanaSocket.md#authorized) - -### Methods - -- [getPeerCertificate](client._internal_namespace.IKibanaSocket.md#getpeercertificate) -- [getProtocol](client._internal_namespace.IKibanaSocket.md#getprotocol) -- [renegotiate](client._internal_namespace.IKibanaSocket.md#renegotiate) - -## Properties - -### authorizationError - -• `Optional` `Readonly` **authorizationError**: `Error` - -The reason why the peer's certificate has not been verified. This property becomes available -only when `authorized` is `false`. - -#### Defined in - -src/core/target/types/server/http/router/socket.d.ts:45 - -___ - -### authorized - -• `Optional` `Readonly` **authorized**: `boolean` - -Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS -isn't used the value is `undefined`. - -#### Defined in - -src/core/target/types/server/http/router/socket.d.ts:40 - -## Methods - -### getPeerCertificate - -▸ **getPeerCertificate**(`detailed`): ``null`` \| `DetailedPeerCertificate` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `detailed` | ``true`` | - -#### Returns - -``null`` \| `DetailedPeerCertificate` - -#### Defined in - -src/core/target/types/server/http/router/socket.d.ts:9 - -▸ **getPeerCertificate**(`detailed`): ``null`` \| `PeerCertificate` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `detailed` | ``false`` | - -#### Returns - -``null`` \| `PeerCertificate` - -#### Defined in - -src/core/target/types/server/http/router/socket.d.ts:10 - -▸ **getPeerCertificate**(`detailed?`): ``null`` \| `DetailedPeerCertificate` \| `PeerCertificate` - -Returns an object representing the peer's certificate. -The returned object has some properties corresponding to the field of the certificate. -If detailed argument is true the full chain with issuer property will be returned, -if false only the top certificate without issuer property. -If the peer does not provide a certificate, it returns null. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `detailed?` | `boolean` | If true; the full chain with issuer property will be returned. | - -#### Returns - -``null`` \| `DetailedPeerCertificate` \| `PeerCertificate` - -An object representing the peer's certificate. - -#### Defined in - -src/core/target/types/server/http/router/socket.d.ts:20 - -___ - -### getProtocol - -▸ **getProtocol**(): ``null`` \| `string` - -Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for -connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected -client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information. - -#### Returns - -``null`` \| `string` - -#### Defined in - -src/core/target/types/server/http/router/socket.d.ts:26 - -___ - -### renegotiate - -▸ **renegotiate**(`options`): `Promise`<`void`\> - -Renegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | `Object` | The options may contain the following fields: rejectUnauthorized, requestCert (See tls.createServer() for details). | -| `options.rejectUnauthorized?` | `boolean` | - | -| `options.requestCert?` | `boolean` | - | - -#### Returns - -`Promise`<`void`\> - -A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed. - -#### Defined in - -src/core/target/types/server/http/router/socket.d.ts:32 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ILicense.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ILicense.md deleted file mode 100644 index 8449411b85e425..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ILicense.md +++ /dev/null @@ -1,236 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ILicense - -# Interface: ILicense - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ILicense - -## Table of contents - -### Properties - -- [error](client._internal_namespace.ILicense.md#error) -- [expiryDateInMillis](client._internal_namespace.ILicense.md#expirydateinmillis) -- [isActive](client._internal_namespace.ILicense.md#isactive) -- [isAvailable](client._internal_namespace.ILicense.md#isavailable) -- [mode](client._internal_namespace.ILicense.md#mode) -- [signature](client._internal_namespace.ILicense.md#signature) -- [status](client._internal_namespace.ILicense.md#status) -- [type](client._internal_namespace.ILicense.md#type) -- [uid](client._internal_namespace.ILicense.md#uid) - -### Methods - -- [check](client._internal_namespace.ILicense.md#check) -- [getFeature](client._internal_namespace.ILicense.md#getfeature) -- [getUnavailableReason](client._internal_namespace.ILicense.md#getunavailablereason) -- [hasAtLeast](client._internal_namespace.ILicense.md#hasatleast) -- [toJSON](client._internal_namespace.ILicense.md#tojson) - -## Properties - -### error - -• `Optional` **error**: `string` - -A potential error denoting the failure of the license from being retrieved. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:119 - -___ - -### expiryDateInMillis - -• `Optional` **expiryDateInMillis**: `number` - -Unix epoch of the expiration date of the license. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:94 - -___ - -### isActive - -• **isActive**: `boolean` - -Determine if the status of the license is active. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:90 - -___ - -### isAvailable - -• **isAvailable**: `boolean` - -Determine if the license container has information. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:111 - -___ - -### mode - -• `Optional` **mode**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -The license type, being usually one of basic, standard, gold, platinum, or trial. - -**`deprecated`** use 'type' instead. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:103 - -___ - -### signature - -• **signature**: `string` - -Signature of the license content. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:107 - -___ - -### status - -• `Optional` **status**: [`LicenseStatus`](../modules/client._internal_namespace.md#licensestatus) - -The validity status of the license. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:86 - -___ - -### type - -• `Optional` **type**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -The license type, being usually one of basic, standard, gold, platinum, or trial. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:98 - -___ - -### uid - -• `Optional` **uid**: `string` - -UID for license. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:82 - -## Methods - -### check - -▸ **check**(`pluginName`, `minimumLicenseRequired`): [`LicenseCheck`](client._internal_namespace.LicenseCheck.md) - -For a given plugin and license type, receive information about the status of the license. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `pluginName` | `string` | the name of the plugin | -| `minimumLicenseRequired` | ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` | the minimum valid license for operating the given plugin | - -#### Returns - -[`LicenseCheck`](client._internal_namespace.LicenseCheck.md) - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:134 - -___ - -### getFeature - -▸ **getFeature**(`name`): [`LicenseFeature`](client._internal_namespace.LicenseFeature.md) - -A specific API for interacting with the specific features of the license. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` | the name of the feature to interact with | - -#### Returns - -[`LicenseFeature`](client._internal_namespace.LicenseFeature.md) - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:139 - -___ - -### getUnavailableReason - -▸ **getUnavailableReason**(): `undefined` \| `string` - -If the license is not available, provides a string or Error containing the reason. - -#### Returns - -`undefined` \| `string` - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:123 - -___ - -### hasAtLeast - -▸ **hasAtLeast**(`minimumLicenseRequired`): `boolean` - -Determine if license type >= minimal required license type. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `minimumLicenseRequired` | ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` | the minimum valid license required for the given feature | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:128 - -___ - -### toJSON - -▸ **toJSON**(): [`PublicLicenseJSON`](client._internal_namespace.PublicLicenseJSON.md) - -Returns - -#### Returns - -[`PublicLicenseJSON`](client._internal_namespace.PublicLicenseJSON.md) - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:115 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md deleted file mode 100644 index 17a5e67c8b2b68..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md +++ /dev/null @@ -1,61 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ISavedObjectsPointInTimeFinder - -# Interface: ISavedObjectsPointInTimeFinder - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ISavedObjectsPointInTimeFinder - -## Type parameters - -| Name | -| :------ | -| `T` | -| `A` | - -## Table of contents - -### Methods - -- [close](client._internal_namespace.ISavedObjectsPointInTimeFinder.md#close) -- [find](client._internal_namespace.ISavedObjectsPointInTimeFinder.md#find) - -## Methods - -### close - -▸ **close**(): `Promise`<`void`\> - -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. - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/point_in_time_finder.d.ts:43 - -___ - -### find - -▸ **find**(): `AsyncGenerator`<[`SavedObjectsFindResponse`](client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>, `any`, `unknown`\> - -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. - -#### Returns - -`AsyncGenerator`<[`SavedObjectsFindResponse`](client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>, `any`, `unknown`\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/point_in_time_finder.d.ts:32 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IScopedClusterClient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IScopedClusterClient.md deleted file mode 100644 index 47f82632322909..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IScopedClusterClient.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IScopedClusterClient - -# Interface: IScopedClusterClient - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IScopedClusterClient - -Serves the same purpose as the normal {@link IClusterClient | cluster client} but exposes -an additional `asCurrentUser` method that doesn't use credentials of the Kibana internal -user (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers -extracted from the current user request to the API instead. - -## Table of contents - -### Properties - -- [asCurrentUser](client._internal_namespace.IScopedClusterClient.md#ascurrentuser) -- [asInternalUser](client._internal_namespace.IScopedClusterClient.md#asinternaluser) - -## Properties - -### asCurrentUser - -• `Readonly` **asCurrentUser**: [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) - -A [client](../modules/client._internal_namespace.md#elasticsearchclient) to be used to query the elasticsearch cluster -on behalf of the user that initiated the request to the Kibana server. - -#### Defined in - -src/core/target/types/server/elasticsearch/client/scoped_cluster_client.d.ts:20 - -___ - -### asInternalUser - -• `Readonly` **asInternalUser**: [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) - -A [client](../modules/client._internal_namespace.md#elasticsearchclient) to be used to query the elasticsearch cluster -on behalf of the internal Kibana user. - -#### Defined in - -src/core/target/types/server/elasticsearch/client/scoped_cluster_client.d.ts:15 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISpacesClient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISpacesClient.md deleted file mode 100644 index 5b7aab2435b5ab..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISpacesClient.md +++ /dev/null @@ -1,151 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ISpacesClient - -# Interface: ISpacesClient - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ISpacesClient - -Client interface for interacting with spaces. - -## Table of contents - -### Methods - -- [create](client._internal_namespace.ISpacesClient.md#create) -- [delete](client._internal_namespace.ISpacesClient.md#delete) -- [disableLegacyUrlAliases](client._internal_namespace.ISpacesClient.md#disablelegacyurlaliases) -- [get](client._internal_namespace.ISpacesClient.md#get) -- [getAll](client._internal_namespace.ISpacesClient.md#getall) -- [update](client._internal_namespace.ISpacesClient.md#update) - -## Methods - -### create - -▸ **create**(`space`): `Promise`<[`Space`](client._internal_namespace.Space.md)\> - -Creates a space. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `space` | [`Space`](client._internal_namespace.Space.md) | the space to create. | - -#### Returns - -`Promise`<[`Space`](client._internal_namespace.Space.md)\> - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:22 - -___ - -### delete - -▸ **delete**(`id`): `Promise`<`void`\> - -Deletes a space, and all saved objects belonging to that space. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | the id of the space to delete. | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:33 - -___ - -### disableLegacyUrlAliases - -▸ **disableLegacyUrlAliases**(`aliases`): `Promise`<`void`\> - -Disables the specified legacy URL aliases. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `aliases` | [`LegacyUrlAliasTarget`](client._internal_namespace.LegacyUrlAliasTarget.md)[] | the aliases to disable. | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:38 - -___ - -### get - -▸ **get**(`id`): `Promise`<[`Space`](client._internal_namespace.Space.md)\> - -Retrieve a space by its id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | the space id. | - -#### Returns - -`Promise`<[`Space`](client._internal_namespace.Space.md)\> - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:17 - -___ - -### getAll - -▸ **getAll**(`options?`): `Promise`<[`GetSpaceResult`](client._internal_namespace.GetSpaceResult.md)[]\> - -Retrieve all available spaces. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | [`GetAllSpacesOptions`](client._internal_namespace.GetAllSpacesOptions.md) | controls which spaces are retrieved. | - -#### Returns - -`Promise`<[`GetSpaceResult`](client._internal_namespace.GetSpaceResult.md)[]\> - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:12 - -___ - -### update - -▸ **update**(`id`, `space`): `Promise`<[`Space`](client._internal_namespace.Space.md)\> - -Updates a space. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | the id of the space to update. | -| `space` | [`Space`](client._internal_namespace.Space.md) | the updated space. | - -#### Returns - -`Promise`<[`Space`](client._internal_namespace.Space.md)\> - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:28 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IUsageCounter.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IUsageCounter.md deleted file mode 100644 index 9ed76ff78e51bd..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IUsageCounter.md +++ /dev/null @@ -1,37 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IUsageCounter - -# Interface: IUsageCounter - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IUsageCounter - -Usage Counter allows to keep track of any events that occur. -By calling [IUsageCounter.incrementCounter](client._internal_namespace.IUsageCounter.md#incrementcounter) devs can notify this -API whenever the event happens. - -## Table of contents - -### Methods - -- [incrementCounter](client._internal_namespace.IUsageCounter.md#incrementcounter) - -## Methods - -### incrementCounter - -▸ **incrementCounter**(`params`): `void` - -Notifies the counter about a new event happening so it can increase the count internally. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IncrementCounterParams`](client._internal_namespace.IncrementCounterParams.md) | [IncrementCounterParams](client._internal_namespace.IncrementCounterParams.md) | - -#### Returns - -`void` - -#### Defined in - -src/plugins/usage_collection/target/types/server/usage_counters/usage_counter.d.ts:33 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IncrementCounterParams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IncrementCounterParams.md deleted file mode 100644 index 0c79f0d867cdcb..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IncrementCounterParams.md +++ /dev/null @@ -1,51 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IncrementCounterParams - -# Interface: IncrementCounterParams - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IncrementCounterParams - -Details about the counter to be incremented - -## Table of contents - -### Properties - -- [counterName](client._internal_namespace.IncrementCounterParams.md#countername) -- [counterType](client._internal_namespace.IncrementCounterParams.md#countertype) -- [incrementBy](client._internal_namespace.IncrementCounterParams.md#incrementby) - -## Properties - -### counterName - -• **counterName**: `string` - -The name of the counter - -#### Defined in - -src/plugins/usage_collection/target/types/server/usage_counters/usage_counter.d.ts:17 - -___ - -### counterType - -• `Optional` **counterType**: `string` - -The counter type ("count" by default) - -#### Defined in - -src/plugins/usage_collection/target/types/server/usage_counters/usage_counter.d.ts:19 - -___ - -### incrementBy - -• `Optional` **incrementBy**: `number` - -Increment the counter by this number (1 if not specified) - -#### Defined in - -src/plugins/usage_collection/target/types/server/usage_counters/usage_counter.d.ts:21 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMapping.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMapping.md deleted file mode 100644 index 71cfddb7c89816..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMapping.md +++ /dev/null @@ -1,45 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IndexMapping - -# Interface: IndexMapping - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IndexMapping - -**`internal`** - -## Table of contents - -### Properties - -- [\_meta](client._internal_namespace.IndexMapping.md#_meta) -- [dynamic](client._internal_namespace.IndexMapping.md#dynamic) -- [properties](client._internal_namespace.IndexMapping.md#properties) - -## Properties - -### \_meta - -• `Optional` **\_meta**: [`IndexMappingMeta`](client._internal_namespace.IndexMappingMeta.md) - -#### Defined in - -src/core/target/types/server/saved_objects/mappings/types.d.ts:104 - -___ - -### dynamic - -• `Optional` **dynamic**: `boolean` \| ``"strict"`` - -#### Defined in - -src/core/target/types/server/saved_objects/mappings/types.d.ts:102 - -___ - -### properties - -• **properties**: [`SavedObjectsMappingProperties`](client._internal_namespace.SavedObjectsMappingProperties.md) - -#### Defined in - -src/core/target/types/server/saved_objects/mappings/types.d.ts:103 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMappingMeta.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMappingMeta.md deleted file mode 100644 index de9e76ae00099f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMappingMeta.md +++ /dev/null @@ -1,27 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IndexMappingMeta - -# Interface: IndexMappingMeta - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IndexMappingMeta - -**`internal`** - -## Table of contents - -### Properties - -- [migrationMappingPropertyHashes](client._internal_namespace.IndexMappingMeta.md#migrationmappingpropertyhashes) - -## Properties - -### migrationMappingPropertyHashes - -• `Optional` **migrationMappingPropertyHashes**: `Object` - -#### Index signature - -▪ [k: `string`]: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/mappings/types.d.ts:108 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IntervalSchedule.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IntervalSchedule.md deleted file mode 100644 index 365dfd5f7dfdf0..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IntervalSchedule.md +++ /dev/null @@ -1,23 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IntervalSchedule - -# Interface: IntervalSchedule - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IntervalSchedule - -## Table of contents - -### Properties - -- [interval](client._internal_namespace.IntervalSchedule.md#interval) - -## Properties - -### interval - -• **interval**: `string` - -An interval in minutes (e.g. '5m'). If specified, this is a recurring task. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:137 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaFeatureConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaFeatureConfig.md deleted file mode 100644 index 2013e42ad5bf25..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaFeatureConfig.md +++ /dev/null @@ -1,257 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaFeatureConfig - -# Interface: KibanaFeatureConfig - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaFeatureConfig - -Interface for registering a feature. -Feature registration allows plugins to hide their applications with spaces, -and secure access when configured for security. - -## Table of contents - -### Properties - -- [alerting](client._internal_namespace.KibanaFeatureConfig.md#alerting) -- [app](client._internal_namespace.KibanaFeatureConfig.md#app) -- [cases](client._internal_namespace.KibanaFeatureConfig.md#cases) -- [catalogue](client._internal_namespace.KibanaFeatureConfig.md#catalogue) -- [category](client._internal_namespace.KibanaFeatureConfig.md#category) -- [excludeFromBasePrivileges](client._internal_namespace.KibanaFeatureConfig.md#excludefrombaseprivileges) -- [id](client._internal_namespace.KibanaFeatureConfig.md#id) -- [management](client._internal_namespace.KibanaFeatureConfig.md#management) -- [minimumLicense](client._internal_namespace.KibanaFeatureConfig.md#minimumlicense) -- [name](client._internal_namespace.KibanaFeatureConfig.md#name) -- [order](client._internal_namespace.KibanaFeatureConfig.md#order) -- [privileges](client._internal_namespace.KibanaFeatureConfig.md#privileges) -- [privilegesTooltip](client._internal_namespace.KibanaFeatureConfig.md#privilegestooltip) -- [reserved](client._internal_namespace.KibanaFeatureConfig.md#reserved) -- [subFeatures](client._internal_namespace.KibanaFeatureConfig.md#subfeatures) - -## Properties - -### alerting - -• `Optional` **alerting**: readonly `string`[] - -If your feature grants access to specific Alert Types, you can specify them here to control visibility based on the current space. -Include both Alert Types registered by the feature and external Alert Types such as built-in -Alert Types and Alert Types provided by other features to which you wish to grant access. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:83 - -___ - -### app - -• **app**: readonly `string`[] - -An array of app ids that are enabled when this feature is enabled. -Apps specified here will automatically cascade to the privileges defined below, unless specified differently there. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:54 - -___ - -### cases - -• `Optional` **cases**: readonly `string`[] - -If your feature grants access to specific case types, you can specify them here to control visibility based on the current space. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:87 - -___ - -### catalogue - -• `Optional` **catalogue**: readonly `string`[] - -If this feature includes a catalogue entry, you can specify them here to control visibility based on the current space. - -Items specified here will automatically cascade to the privileges defined below, unless specified differently there. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:77 - -___ - -### category - -• **category**: [`AppCategory`](client._internal_namespace.AppCategory.md) - -The category for this feature. -This will be used to organize the list of features for display within the -Spaces and Roles management screens. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:30 - -___ - -### excludeFromBasePrivileges - -• `Optional` **excludeFromBasePrivileges**: `boolean` - -Whether or not this feature should be excluded from the base privileges. -This is primarily helpful when migrating applications with a "legacy" privileges model -to use Kibana privileges. We don't want these features to be considered part of the `all` -or `read` base privileges in a minor release if the user was previously granted access -using an additional reserved role. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:42 - -___ - -### id - -• **id**: `string` - -Unique identifier for this feature. -This identifier is also used when generating UI Capabilities. - -**`see`** UICapabilities - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:19 - -___ - -### management - -• `Optional` **management**: `Object` - -If this feature includes management sections, you can specify them here to control visibility of those -pages based on the current space. - -Items specified here will automatically cascade to the privileges defined below, unless specified differently there. - -**`example`** -```ts - // Enables access to the "Advanced Settings" management page within the Kibana section - management: { - kibana: ['settings'] - } -``` - -#### Index signature - -▪ [sectionId: `string`]: readonly `string`[] - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:69 - -___ - -### minimumLicense - -• `Optional` **minimumLicense**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -Optional minimum supported license. -If omitted, all licenses are allowed. -This does not restrict access to your feature based on license. -Its only purpose is to inform the space and roles UIs on which features to display. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:49 - -___ - -### name - -• **name**: `string` - -Display name for this feature. -This will be displayed to end-users, so a translatable string is advised for i18n. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:24 - -___ - -### order - -• `Optional` **order**: `number` - -An ordinal used to sort features relative to one another for display. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:34 - -___ - -### privileges - -• **privileges**: ``null`` \| { `all`: [`FeatureKibanaPrivileges`](client._internal_namespace.FeatureKibanaPrivileges.md) ; `read`: [`FeatureKibanaPrivileges`](client._internal_namespace.FeatureKibanaPrivileges.md) } - -Feature privilege definition. - -**`example`** -```ts - { - all: {...}, - read: {...} - } -``` - -**`see`** FeatureKibanaPrivileges - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:100 - -___ - -### privilegesTooltip - -• `Optional` **privilegesTooltip**: `string` - -Optional message to display on the Role Management screen when configuring permissions for this feature. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:111 - -___ - -### reserved - -• `Optional` `Private` **reserved**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `description` | `string` | -| `privileges` | readonly [`ReservedKibanaPrivilege`](client._internal_namespace.ReservedKibanaPrivilege.md)[] | - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:115 - -___ - -### subFeatures - -• `Optional` **subFeatures**: readonly [`SubFeatureConfig`](client._internal_namespace.SubFeatureConfig.md)[] - -Optional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined. - -#### Defined in - -x-pack/plugins/features/target/types/common/kibana_feature.d.ts:107 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorOptions.md deleted file mode 100644 index 1b316e68c57718..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorOptions.md +++ /dev/null @@ -1,76 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaMigratorOptions - -# Interface: KibanaMigratorOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaMigratorOptions - -## Table of contents - -### Properties - -- [client](client._internal_namespace.KibanaMigratorOptions.md#client) -- [kibanaIndex](client._internal_namespace.KibanaMigratorOptions.md#kibanaindex) -- [kibanaVersion](client._internal_namespace.KibanaMigratorOptions.md#kibanaversion) -- [logger](client._internal_namespace.KibanaMigratorOptions.md#logger) -- [soMigrationsConfig](client._internal_namespace.KibanaMigratorOptions.md#somigrationsconfig) -- [typeRegistry](client._internal_namespace.KibanaMigratorOptions.md#typeregistry) - -## Properties - -### client - -• **client**: [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:10 - -___ - -### kibanaIndex - -• **kibanaIndex**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:13 - -___ - -### kibanaVersion - -• **kibanaVersion**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:14 - -___ - -### logger - -• **logger**: `Logger` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:15 - -___ - -### soMigrationsConfig - -• **soMigrationsConfig**: `Readonly`<{} & { `batchSize`: `number` ; `maxBatchSizeBytes`: `ByteSizeValue` ; `pollInterval`: `number` ; `retryAttempts`: `number` ; `scrollDuration`: `string` ; `skip`: `boolean` }\> - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:12 - -___ - -### typeRegistry - -• **typeRegistry**: [`ISavedObjectTypeRegistry`](../modules/client._internal_namespace.md#isavedobjecttyperegistry) - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:11 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorStatus.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorStatus.md deleted file mode 100644 index 21bba02200fa43..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorStatus.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaMigratorStatus - -# Interface: KibanaMigratorStatus - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaMigratorStatus - -## Table of contents - -### Properties - -- [result](client._internal_namespace.KibanaMigratorStatus.md#result) -- [status](client._internal_namespace.KibanaMigratorStatus.md#status) -- [waitingIndex](client._internal_namespace.KibanaMigratorStatus.md#waitingindex) - -## Properties - -### result - -• `Optional` **result**: [`MigrationResult`](../modules/client._internal_namespace.md#migrationresult)[] - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:20 - -___ - -### status - -• **status**: [`MigrationStatus`](../modules/client._internal_namespace.md#migrationstatus) - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:19 - -___ - -### waitingIndex - -• `Optional` **waitingIndex**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:21 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaRequestEvents.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaRequestEvents.md deleted file mode 100644 index c4b610af9ba99a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaRequestEvents.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaRequestEvents - -# Interface: KibanaRequestEvents - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaRequestEvents - -Request events. - -## Table of contents - -### Properties - -- [aborted$](client._internal_namespace.KibanaRequestEvents.md#aborted$) -- [completed$](client._internal_namespace.KibanaRequestEvents.md#completed$) - -## Properties - -### aborted$ - -• **aborted$**: `Observable`<`void`\> - -Observable that emits once if and when the request has been aborted. - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:48 - -___ - -### completed$ - -• **completed$**: `Observable`<`void`\> - -Observable that emits once if and when the request has been completely handled. - -**`remarks`** -The request may be considered completed if: -- A response has been sent to the client; or -- The request was aborted. - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:57 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LegacyUrlAliasTarget.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LegacyUrlAliasTarget.md deleted file mode 100644 index 1580adc5c31275..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LegacyUrlAliasTarget.md +++ /dev/null @@ -1,51 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LegacyUrlAliasTarget - -# Interface: LegacyUrlAliasTarget - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LegacyUrlAliasTarget - -Client interface for interacting with legacy URL aliases. - -## Table of contents - -### Properties - -- [sourceId](client._internal_namespace.LegacyUrlAliasTarget.md#sourceid) -- [targetSpace](client._internal_namespace.LegacyUrlAliasTarget.md#targetspace) -- [targetType](client._internal_namespace.LegacyUrlAliasTarget.md#targettype) - -## Properties - -### sourceId - -• **sourceId**: `string` - -The original ID of the object, before it was converted. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:99 - -___ - -### targetSpace - -• **targetSpace**: `string` - -The namespace that the object existed in when it was converted. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:91 - -___ - -### targetType - -• **targetType**: `string` - -The type of the object when it was converted. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:95 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseCheck.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseCheck.md deleted file mode 100644 index 084c5ae23607e3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseCheck.md +++ /dev/null @@ -1,36 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LicenseCheck - -# Interface: LicenseCheck - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LicenseCheck - -## Table of contents - -### Properties - -- [message](client._internal_namespace.LicenseCheck.md#message) -- [state](client._internal_namespace.LicenseCheck.md#state) - -## Properties - -### message - -• `Optional` **message**: `string` - -A message containing the reason for a license type not being valid. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:75 - -___ - -### state - -• **state**: [`LicenseCheckState`](../modules/client._internal_namespace.md#licensecheckstate) - -The state of checking the results of a license type meeting the license minimum. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:71 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseFeature.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseFeature.md deleted file mode 100644 index e6794cd50d933d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseFeature.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LicenseFeature - -# Interface: LicenseFeature - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LicenseFeature - -## Table of contents - -### Properties - -- [isAvailable](client._internal_namespace.LicenseFeature.md#isavailable) -- [isEnabled](client._internal_namespace.LicenseFeature.md#isenabled) - -## Properties - -### isAvailable - -• **isAvailable**: `boolean` - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:16 - -___ - -### isEnabled - -• **isEnabled**: `boolean` - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:17 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicensingPluginSetup.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicensingPluginSetup.md deleted file mode 100644 index 240dbd27ad2fc5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicensingPluginSetup.md +++ /dev/null @@ -1,60 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LicensingPluginSetup - -# Interface: LicensingPluginSetup - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LicensingPluginSetup - -## Table of contents - -### Properties - -- [featureUsage](client._internal_namespace.LicensingPluginSetup.md#featureusage) -- [license$](client._internal_namespace.LicensingPluginSetup.md#license$) - -### Methods - -- [refresh](client._internal_namespace.LicensingPluginSetup.md#refresh) - -## Properties - -### featureUsage - -• **featureUsage**: [`FeatureUsageServiceSetup`](client._internal_namespace.FeatureUsageServiceSetup.md) - -APIs to register licensed feature usage. - -#### Defined in - -x-pack/plugins/licensing/target/types/server/types.d.ts:49 - -___ - -### license$ - -• **license$**: `Observable`<[`ILicense`](client._internal_namespace.ILicense.md)\> - -Steam of licensing information [ILicense](client._internal_namespace.ILicense.md). - -**`deprecated`** in favour of the counterpart provided from start contract - -#### Defined in - -x-pack/plugins/licensing/target/types/server/types.d.ts:40 - -## Methods - -### refresh - -▸ **refresh**(): `Promise`<[`ILicense`](client._internal_namespace.ILicense.md)\> - -Triggers licensing information re-fetch. - -**`deprecated`** in favour of the counterpart provided from start contract - -#### Returns - -`Promise`<[`ILicense`](client._internal_namespace.ILicense.md)\> - -#### Defined in - -x-pack/plugins/licensing/target/types/server/types.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Middleware.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Middleware.md deleted file mode 100644 index 0a6d5169b4278a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Middleware.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Middleware - -# Interface: Middleware - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Middleware - -## Table of contents - -### Properties - -- [beforeMarkRunning](client._internal_namespace.Middleware.md#beforemarkrunning) -- [beforeRun](client._internal_namespace.Middleware.md#beforerun) -- [beforeSave](client._internal_namespace.Middleware.md#beforesave) - -## Properties - -### beforeMarkRunning - -• **beforeMarkRunning**: [`BeforeRunContextFunction`](../modules/client._internal_namespace.md#beforeruncontextfunction) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:11 - -___ - -### beforeRun - -• **beforeRun**: [`BeforeRunContextFunction`](../modules/client._internal_namespace.md#beforeruncontextfunction) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:10 - -___ - -### beforeSave - -• **beforeSave**: [`BeforeSaveContextFunction`](../modules/client._internal_namespace.md#beforesavecontextfunction) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:9 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OperationDetails.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OperationDetails.md deleted file mode 100644 index a7e428f943d059..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OperationDetails.md +++ /dev/null @@ -1,91 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / OperationDetails - -# Interface: OperationDetails - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).OperationDetails - -Defines the structure for a case API route. - -## Table of contents - -### Properties - -- [action](client._internal_namespace.OperationDetails.md#action) -- [docType](client._internal_namespace.OperationDetails.md#doctype) -- [ecsType](client._internal_namespace.OperationDetails.md#ecstype) -- [name](client._internal_namespace.OperationDetails.md#name) -- [savedObjectType](client._internal_namespace.OperationDetails.md#savedobjecttype) -- [verbs](client._internal_namespace.OperationDetails.md#verbs) - -## Properties - -### action - -• **action**: `string` - -The ECS `event.action` field, should be in the form of _ e.g comment_get, case_fined - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:83](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L83) - -___ - -### docType - -• **docType**: `string` - -The readable name of the entity being operated on e.g. case, comment, configurations (make it plural if it reads better that way etc) - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:91](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L91) - -___ - -### ecsType - -• **ecsType**: `EcsEventType` - -The ECS event type that this operation should be audit logged as (creation, deletion, access, etc) - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:74](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L74) - -___ - -### name - -• **name**: `string` - -The name of the operation to authorize against for the privilege check. -These values need to match one of the operation strings defined here: x-pack/plugins/security/server/authorization/privileges/feature_privilege_builder/cases.ts - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L79) - -___ - -### savedObjectType - -• **savedObjectType**: `string` - -The actual saved object type of the entity e.g. cases, cases-comments - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:95](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L95) - -___ - -### verbs - -• **verbs**: [`Verbs`](client._internal_namespace.Verbs.md) - -The verbs that are associated with this type of operation, these should line up with the event type e.g. creating, created, create etc - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:87](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L87) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OwnerEntity.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OwnerEntity.md deleted file mode 100644 index 771823c8e9711f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OwnerEntity.md +++ /dev/null @@ -1,35 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / OwnerEntity - -# Interface: OwnerEntity - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).OwnerEntity - -Describes an entity with the necessary fields to identify if the user is authorized to interact with the saved object -returned from some find query. - -## Table of contents - -### Properties - -- [id](client._internal_namespace.OwnerEntity.md#id) -- [owner](client._internal_namespace.OwnerEntity.md#owner) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:104](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L104) - -___ - -### owner - -• **owner**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:103](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L103) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCase.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCase.md deleted file mode 100644 index 39774f46c552f7..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCase.md +++ /dev/null @@ -1,54 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PatchCase - -# Interface: PatchCase - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PatchCase - -## Table of contents - -### Properties - -- [caseId](client._internal_namespace.PatchCase.md#caseid) -- [originalCase](client._internal_namespace.PatchCase.md#originalcase) -- [updatedAttributes](client._internal_namespace.PatchCase.md#updatedattributes) -- [version](client._internal_namespace.PatchCase.md#version) - -## Properties - -### caseId - -• **caseId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:98](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L98) - -___ - -### originalCase - -• **originalCase**: [`SavedObject`](client._internal_namespace.SavedObject.md)<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:100](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L100) - -___ - -### updatedAttributes - -• **updatedAttributes**: `Partial`<{ `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & [`PushedArgs`](client._internal_namespace.PushedArgs.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:99](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L99) - -___ - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:101](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L101) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCaseConfigureArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCaseConfigureArgs.md deleted file mode 100644 index c6909426e10883..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCaseConfigureArgs.md +++ /dev/null @@ -1,64 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PatchCaseConfigureArgs - -# Interface: PatchCaseConfigureArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PatchCaseConfigureArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs.md) - - ↳ **`PatchCaseConfigureArgs`** - -## Table of contents - -### Properties - -- [configurationId](client._internal_namespace.PatchCaseConfigureArgs.md#configurationid) -- [originalConfiguration](client._internal_namespace.PatchCaseConfigureArgs.md#originalconfiguration) -- [unsecuredSavedObjectsClient](client._internal_namespace.PatchCaseConfigureArgs.md#unsecuredsavedobjectsclient) -- [updatedAttributes](client._internal_namespace.PatchCaseConfigureArgs.md#updatedattributes) - -## Properties - -### configurationId - -• **configurationId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:46](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L46) - -___ - -### originalConfiguration - -• **originalConfiguration**: [`SavedObject`](client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\> - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:48](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L48) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) - -___ - -### updatedAttributes - -• **updatedAttributes**: `Partial`<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\> - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:47](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L47) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCasesArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCasesArgs.md deleted file mode 100644 index 24db998f64f3d7..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCasesArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PatchCasesArgs - -# Interface: PatchCasesArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PatchCasesArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`PatchCasesArgs`** - -## Table of contents - -### Properties - -- [cases](client._internal_namespace.PatchCasesArgs.md#cases) -- [unsecuredSavedObjectsClient](client._internal_namespace.PatchCasesArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### cases - -• **cases**: [`PatchCase`](client._internal_namespace.PatchCase.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:106](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L106) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PersistableState.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PersistableState.md deleted file mode 100644 index 7300cc96a8fd2d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PersistableState.md +++ /dev/null @@ -1,133 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PersistableState - -# Interface: PersistableState - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PersistableState - -Persistable state interface can be implemented by something that persists -(stores) state, for example, in a saved object. Once implemented that thing -will gain ability to "extract" and "inject" saved object references, which -are necessary for various saved object tasks, such as export. It will also be -able to do state migrations across Kibana versions, if the shape of the state -would change over time. - -**`todo`** Maybe rename it to `PersistableStateItem`? - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `P` | extends `SerializableRecord` = `SerializableRecord` | - -## Table of contents - -### Properties - -- [migrations](client._internal_namespace.PersistableState.md#migrations) - -### Methods - -- [extract](client._internal_namespace.PersistableState.md#extract) -- [inject](client._internal_namespace.PersistableState.md#inject) -- [telemetry](client._internal_namespace.PersistableState.md#telemetry) - -## Properties - -### migrations - -• **migrations**: [`MigrateFunctionsObject`](../modules/client._internal_namespace.md#migratefunctionsobject) \| [`GetMigrationFunctionObjectFn`](../modules/client._internal_namespace.md#getmigrationfunctionobjectfn) - -A list of migration functions, which migrate the persistable state -serializable object to the next version. Migration functions should are -keyed by the Kibana version using semver, where the version indicates to -which version the state will be migrated to. - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:75 - -## Methods - -### extract - -▸ **extract**(`state`): `Object` - -A function which receives state and should return the state with references -extracted and an array of the extracted references. The default case could -simply return the same state with an empty array of references. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | `P` | The persistable state serializable state object. | - -#### Returns - -`Object` - -Persistable state object with references extracted and a list of - references. - -| Name | Type | -| :------ | :------ | -| `references` | [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] | -| `state` | `P` | - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:65 - -___ - -### inject - -▸ **inject**(`state`, `references`): `P` - -A function which receives state and a list of references and should return -back the state with references injected. The default is an identity -function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | `P` | The persistable state serializable state object. | -| `references` | [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] | List of saved object references. | - -#### Returns - -`P` - -Persistable state object with references injected. - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:55 - -___ - -### telemetry - -▸ **telemetry**(`state`, `stats`): `Record`<`string`, `any`\> - -Function which reports telemetry information. This function is essentially -a "reducer" - it receives the existing "stats" object and returns an -updated version of the "stats" object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | `P` | The persistable state serializable state object. | -| `stats` | `Record`<`string`, `any`\> | Stats object containing the stats which were already collected. This `stats` object shall not be mutated in-line. | - -#### Returns - -`Record`<`string`, `any`\> - -A new stats object augmented with new telemetry information. - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PluginStartContract.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PluginStartContract.md deleted file mode 100644 index 3ded8d5c506428..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PluginStartContract.md +++ /dev/null @@ -1,40 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PluginStartContract - -# Interface: PluginStartContract - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PluginStartContract - -## Table of contents - -### Methods - -- [getElasticsearchFeatures](client._internal_namespace.PluginStartContract.md#getelasticsearchfeatures) -- [getKibanaFeatures](client._internal_namespace.PluginStartContract.md#getkibanafeatures) - -## Methods - -### getElasticsearchFeatures - -▸ **getElasticsearchFeatures**(): [`ElasticsearchFeature`](../classes/client._internal_namespace.ElasticsearchFeature.md)[] - -#### Returns - -[`ElasticsearchFeature`](../classes/client._internal_namespace.ElasticsearchFeature.md)[] - -#### Defined in - -x-pack/plugins/features/target/types/server/plugin.d.ts:28 - -___ - -### getKibanaFeatures - -▸ **getKibanaFeatures**(): [`KibanaFeature`](../classes/client._internal_namespace.KibanaFeature.md)[] - -#### Returns - -[`KibanaFeature`](../classes/client._internal_namespace.KibanaFeature.md)[] - -#### Defined in - -x-pack/plugins/features/target/types/server/plugin.d.ts:29 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseArgs.md deleted file mode 100644 index 03690ece438b77..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseArgs.md +++ /dev/null @@ -1,53 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PostCaseArgs - -# Interface: PostCaseArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PostCaseArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`PostCaseArgs`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.PostCaseArgs.md#attributes) -- [id](client._internal_namespace.PostCaseArgs.md#id) -- [unsecuredSavedObjectsClient](client._internal_namespace.PostCaseArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### attributes - -• **attributes**: { `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:93](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L93) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:94](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L94) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseConfigureArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseConfigureArgs.md deleted file mode 100644 index b10f3e3ae51bab..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseConfigureArgs.md +++ /dev/null @@ -1,53 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PostCaseConfigureArgs - -# Interface: PostCaseConfigureArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PostCaseConfigureArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs.md) - - ↳ **`PostCaseConfigureArgs`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.PostCaseConfigureArgs.md#attributes) -- [id](client._internal_namespace.PostCaseConfigureArgs.md#id) -- [unsecuredSavedObjectsClient](client._internal_namespace.PostCaseConfigureArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### attributes - -• **attributes**: { `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:41](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L41) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:42](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L42) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseUserActionArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseUserActionArgs.md deleted file mode 100644 index 5b890d18106eaf..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseUserActionArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PostCaseUserActionArgs - -# Interface: PostCaseUserActionArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PostCaseUserActionArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) - - ↳ **`PostCaseUserActionArgs`** - -## Table of contents - -### Properties - -- [actions](client._internal_namespace.PostCaseUserActionArgs.md#actions) -- [unsecuredSavedObjectsClient](client._internal_namespace.PostCaseUserActionArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### actions - -• **actions**: [`BuilderReturnValue`](client._internal_namespace.BuilderReturnValue.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:67](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L67) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostConnectorMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostConnectorMappingsArgs.md deleted file mode 100644 index d4cc3e71a0ba80..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostConnectorMappingsArgs.md +++ /dev/null @@ -1,60 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PostConnectorMappingsArgs - -# Interface: PostConnectorMappingsArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PostConnectorMappingsArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-2.md) - - ↳ **`PostConnectorMappingsArgs`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.PostConnectorMappingsArgs.md#attributes) -- [references](client._internal_namespace.PostConnectorMappingsArgs.md#references) -- [unsecuredSavedObjectsClient](client._internal_namespace.PostConnectorMappingsArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### attributes - -• **attributes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `mappings` | { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] | -| `owner` | `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L22) - -___ - -### references - -• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:23](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L23) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-2.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-2.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PreConfiguredAction.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PreConfiguredAction.md deleted file mode 100644 index d5bd141afd372d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PreConfiguredAction.md +++ /dev/null @@ -1,124 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PreConfiguredAction - -# Interface: PreConfiguredAction - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PreConfiguredAction - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | -| `Secrets` | extends [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) = [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) | - -## Hierarchy - -- [`ActionResult`](client._internal_namespace.ActionResult.md)<`Config`\> - - ↳ **`PreConfiguredAction`** - -## Table of contents - -### Properties - -- [actionTypeId](client._internal_namespace.PreConfiguredAction.md#actiontypeid) -- [config](client._internal_namespace.PreConfiguredAction.md#config) -- [id](client._internal_namespace.PreConfiguredAction.md#id) -- [isMissingSecrets](client._internal_namespace.PreConfiguredAction.md#ismissingsecrets) -- [isPreconfigured](client._internal_namespace.PreConfiguredAction.md#ispreconfigured) -- [name](client._internal_namespace.PreConfiguredAction.md#name) -- [secrets](client._internal_namespace.PreConfiguredAction.md#secrets) - -## Properties - -### actionTypeId - -• **actionTypeId**: `string` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[actionTypeId](client._internal_namespace.ActionResult.md#actiontypeid) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:50 - -___ - -### config - -• `Optional` **config**: `Config` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[config](client._internal_namespace.ActionResult.md#config) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:53 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[id](client._internal_namespace.ActionResult.md#id) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:49 - -___ - -### isMissingSecrets - -• `Optional` **isMissingSecrets**: `boolean` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[isMissingSecrets](client._internal_namespace.ActionResult.md#ismissingsecrets) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:52 - -___ - -### isPreconfigured - -• **isPreconfigured**: `boolean` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[isPreconfigured](client._internal_namespace.ActionResult.md#ispreconfigured) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:54 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -[ActionResult](client._internal_namespace.ActionResult.md).[name](client._internal_namespace.ActionResult.md#name) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:51 - -___ - -### secrets - -• **secrets**: `Secrets` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:57 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ProxySettings.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ProxySettings.md deleted file mode 100644 index e1816a9f513cd1..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ProxySettings.md +++ /dev/null @@ -1,65 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ProxySettings - -# Interface: ProxySettings - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ProxySettings - -## Table of contents - -### Properties - -- [proxyBypassHosts](client._internal_namespace.ProxySettings.md#proxybypasshosts) -- [proxyHeaders](client._internal_namespace.ProxySettings.md#proxyheaders) -- [proxyOnlyHosts](client._internal_namespace.ProxySettings.md#proxyonlyhosts) -- [proxySSLSettings](client._internal_namespace.ProxySettings.md#proxysslsettings) -- [proxyUrl](client._internal_namespace.ProxySettings.md#proxyurl) - -## Properties - -### proxyBypassHosts - -• **proxyBypassHosts**: `undefined` \| `Set`<`string`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:110 - -___ - -### proxyHeaders - -• `Optional` **proxyHeaders**: `Record`<`string`, `string`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:112 - -___ - -### proxyOnlyHosts - -• **proxyOnlyHosts**: `undefined` \| `Set`<`string`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:111 - -___ - -### proxySSLSettings - -• **proxySSLSettings**: [`SSLSettings`](client._internal_namespace.SSLSettings.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:113 - -___ - -### proxyUrl - -• **proxyUrl**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:109 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicense.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicense.md deleted file mode 100644 index 63c54f6be23cd9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicense.md +++ /dev/null @@ -1,80 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PublicLicense - -# Interface: PublicLicense - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PublicLicense - -Subset of license data considered as non-sensitive information. -Can be passed to the client. - -## Table of contents - -### Properties - -- [expiryDateInMillis](client._internal_namespace.PublicLicense.md#expirydateinmillis) -- [mode](client._internal_namespace.PublicLicense.md#mode) -- [status](client._internal_namespace.PublicLicense.md#status) -- [type](client._internal_namespace.PublicLicense.md#type) -- [uid](client._internal_namespace.PublicLicense.md#uid) - -## Properties - -### expiryDateInMillis - -• **expiryDateInMillis**: `number` - -Unix epoch of the expiration date of the license. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:36 - -___ - -### mode - -• **mode**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -The license type, being usually one of basic, standard, gold, platinum, or trial. - -**`deprecated`** use 'type' instead - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:45 - -___ - -### status - -• **status**: [`LicenseStatus`](../modules/client._internal_namespace.md#licensestatus) - -The validity status of the license. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:32 - -___ - -### type - -• **type**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -The license type, being usually one of basic, standard, gold, platinum, or trial. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:40 - -___ - -### uid - -• **uid**: `string` - -UID for license. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:28 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicenseJSON.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicenseJSON.md deleted file mode 100644 index 895a3654baaf27..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicenseJSON.md +++ /dev/null @@ -1,46 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PublicLicenseJSON - -# Interface: PublicLicenseJSON - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PublicLicenseJSON - -Subset of license & features data considered as non-sensitive information. -Structured as json to be passed to the client. - -## Table of contents - -### Properties - -- [features](client._internal_namespace.PublicLicenseJSON.md#features) -- [license](client._internal_namespace.PublicLicenseJSON.md#license) -- [signature](client._internal_namespace.PublicLicenseJSON.md#signature) - -## Properties - -### features - -• `Optional` **features**: [`PublicFeatures`](../modules/client._internal_namespace.md#publicfeatures) - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:59 - -___ - -### license - -• `Optional` **license**: [`PublicLicense`](client._internal_namespace.PublicLicense.md) - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:58 - -___ - -### signature - -• **signature**: `string` - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:60 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PushedArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PushedArgs.md deleted file mode 100644 index 0637bcb1cb21f5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PushedArgs.md +++ /dev/null @@ -1,40 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PushedArgs - -# Interface: PushedArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PushedArgs - -## Table of contents - -### Properties - -- [pushed\_at](client._internal_namespace.PushedArgs.md#pushed_at) -- [pushed\_by](client._internal_namespace.PushedArgs.md#pushed_by) - -## Properties - -### pushed\_at - -• **pushed\_at**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:64](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L64) - -___ - -### pushed\_by - -• **pushed\_by**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:65](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L65) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Referencable.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Referencable.md deleted file mode 100644 index b8914a27eb524c..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Referencable.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Referencable - -# Interface: Referencable - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Referencable - -## Table of contents - -### Properties - -- [references](client._internal_namespace.Referencable.md#references) - -## Properties - -### references - -• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:40 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ReservedKibanaPrivilege.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ReservedKibanaPrivilege.md deleted file mode 100644 index cfd5cc23baa8c6..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ReservedKibanaPrivilege.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ReservedKibanaPrivilege - -# Interface: ReservedKibanaPrivilege - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ReservedKibanaPrivilege - -## Table of contents - -### Properties - -- [id](client._internal_namespace.ReservedKibanaPrivilege.md#id) -- [privilege](client._internal_namespace.ReservedKibanaPrivilege.md#privilege) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -x-pack/plugins/features/target/types/common/reserved_kibana_privilege.d.ts:3 - -___ - -### privilege - -• **privilege**: [`FeatureKibanaPrivileges`](client._internal_namespace.FeatureKibanaPrivileges.md) - -#### Defined in - -x-pack/plugins/features/target/types/common/reserved_kibana_privilege.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ResponseSettings.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ResponseSettings.md deleted file mode 100644 index b5c3a7374e03de..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ResponseSettings.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ResponseSettings - -# Interface: ResponseSettings - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ResponseSettings - -## Table of contents - -### Properties - -- [maxContentLength](client._internal_namespace.ResponseSettings.md#maxcontentlength) -- [timeout](client._internal_namespace.ResponseSettings.md#timeout) - -## Properties - -### maxContentLength - -• **maxContentLength**: `number` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:116 - -___ - -### timeout - -• **timeout**: `number` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:117 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptions.md deleted file mode 100644 index 447612f4b9ece0..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptions.md +++ /dev/null @@ -1,100 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteConfigOptions - -# Interface: RouteConfigOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteConfigOptions - -Additional route options. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Method` | extends [`RouteMethod`](../modules/client._internal_namespace.md#routemethod) | - -## Table of contents - -### Properties - -- [authRequired](client._internal_namespace.RouteConfigOptions.md#authrequired) -- [body](client._internal_namespace.RouteConfigOptions.md#body) -- [tags](client._internal_namespace.RouteConfigOptions.md#tags) -- [timeout](client._internal_namespace.RouteConfigOptions.md#timeout) -- [xsrfRequired](client._internal_namespace.RouteConfigOptions.md#xsrfrequired) - -## Properties - -### authRequired - -• `Optional` **authRequired**: `boolean` \| ``"optional"`` - -Defines authentication mode for a route: -- true. A user has to have valid credentials to access a resource -- false. A user can access a resource without any credentials. -- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid. - Can be useful when we grant access to a resource but want to identify a user if possible. - -Defaults to `true` if an auth mechanism is registered. - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:89 - -___ - -### body - -• `Optional` **body**: `Method` extends ``"options"`` \| ``"get"`` ? `undefined` : [`RouteConfigOptionsBody`](client._internal_namespace.RouteConfigOptionsBody.md) - -Additional body options [RouteConfigOptionsBody](client._internal_namespace.RouteConfigOptionsBody.md). - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:105 - -___ - -### tags - -• `Optional` **tags**: readonly `string`[] - -Additional metadata tag strings to attach to the route. - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:101 - -___ - -### timeout - -• `Optional` **timeout**: `Object` - -Defines per-route timeouts. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `idleSocket?` | `number` | Milliseconds the socket can be idle before it's closed | -| `payload?` | `Method` extends ``"options"`` \| ``"get"`` ? `undefined` : `number` | Milliseconds to receive the payload | - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:109 - -___ - -### xsrfRequired - -• `Optional` **xsrfRequired**: `Method` extends ``"get"`` ? `never` : `boolean` - -Defines xsrf protection requirements for a route: -- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header. -- false. Disables xsrf protection. - -Set to true by default - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:97 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptionsBody.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptionsBody.md deleted file mode 100644 index c392c1845b22a0..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptionsBody.md +++ /dev/null @@ -1,89 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteConfigOptionsBody - -# Interface: RouteConfigOptionsBody - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteConfigOptionsBody - -Additional body options for a route - -## Table of contents - -### Properties - -- [accepts](client._internal_namespace.RouteConfigOptionsBody.md#accepts) -- [maxBytes](client._internal_namespace.RouteConfigOptionsBody.md#maxbytes) -- [output](client._internal_namespace.RouteConfigOptionsBody.md#output) -- [parse](client._internal_namespace.RouteConfigOptionsBody.md#parse) - -## Properties - -### accepts - -• `Optional` **accepts**: `string` \| `string`[] \| [`RouteContentType`](../modules/client._internal_namespace.md#routecontenttype)[] - -A 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 -above will not enable them to be parsed, and if parse is true, the request will result in an error response. - -Default value: allows parsing of the following mime types: -* application/json -* application/*+json -* application/octet-stream -* application/x-www-form-urlencoded -* multipart/form-data -* text/* - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:45 - -___ - -### maxBytes - -• `Optional` **maxBytes**: `number` - -Limits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory. - -Default value: The one set in the kibana.yml config file under the parameter `server.maxPayload`. - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:51 - -___ - -### output - -• `Optional` **output**: ``"data"`` \| ``"stream"`` - -The processed payload format. The value must be one of: -* '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 -Buffer is returned. -* '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 -are 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 -payloads 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 -multipart payload in the handler using a streaming parser (e.g. pez). - -Default value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure. - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:63 - -___ - -### parse - -• `Optional` **parse**: `boolean` \| ``"gunzip"`` - -Determines if the incoming payload is processed or presented raw. Available values: -* 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 -format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. -* false - the raw payload is returned unmodified. -* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded. - -Default value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure. - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:73 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidationResultFactory.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidationResultFactory.md deleted file mode 100644 index 4e45bca74bdee3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidationResultFactory.md +++ /dev/null @@ -1,71 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidationResultFactory - -# Interface: RouteValidationResultFactory - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidationResultFactory - -Validation result factory to be used in the custom validation function to return the valid data or validation errors - -See [RouteValidationFunction](../modules/client._internal_namespace.md#routevalidationfunction). - -## Table of contents - -### Methods - -- [badRequest](client._internal_namespace.RouteValidationResultFactory.md#badrequest) -- [ok](client._internal_namespace.RouteValidationResultFactory.md#ok) - -## Methods - -### badRequest - -▸ **badRequest**(`error`, `path?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `string` \| `Error` | -| `path?` | `string`[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `error` | [`RouteValidationError`](../classes/client._internal_namespace.RouteValidationError.md) | - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:14 - -___ - -### ok - -▸ **ok**<`T`\>(`value`): `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `T` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `value` | `T` | - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:11 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorConfig.md deleted file mode 100644 index dcea2693b8a079..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorConfig.md +++ /dev/null @@ -1,60 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidatorConfig - -# Interface: RouteValidatorConfig - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidatorConfig - -The configuration object to the RouteValidator class. -Set `params`, `query` and/or `body` to specify the validation logic to follow for that property. - -## Type parameters - -| Name | -| :------ | -| `P` | -| `Q` | -| `B` | - -## Table of contents - -### Properties - -- [body](client._internal_namespace.RouteValidatorConfig.md#body) -- [params](client._internal_namespace.RouteValidatorConfig.md#params) -- [query](client._internal_namespace.RouteValidatorConfig.md#query) - -## Properties - -### body - -• `Optional` **body**: [`RouteValidationSpec`](../modules/client._internal_namespace.md#routevalidationspec)<`B`\> - -Validation logic for the body payload - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:79 - -___ - -### params - -• `Optional` **params**: [`RouteValidationSpec`](../modules/client._internal_namespace.md#routevalidationspec)<`P`\> - -Validation logic for the URL params - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:69 - -___ - -### query - -• `Optional` **query**: [`RouteValidationSpec`](../modules/client._internal_namespace.md#routevalidationspec)<`Q`\> - -Validation logic for the Query params - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:74 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorOptions.md deleted file mode 100644 index 2652ad7475e824..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorOptions.md +++ /dev/null @@ -1,33 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidatorOptions - -# Interface: RouteValidatorOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidatorOptions - -Additional options for the RouteValidator class to modify its default behaviour. - -## Table of contents - -### Properties - -- [unsafe](client._internal_namespace.RouteValidatorOptions.md#unsafe) - -## Properties - -### unsafe - -• `Optional` **unsafe**: `Object` - -Set the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `body?` | `boolean` | -| `params?` | `boolean` | -| `query?` | `boolean` | - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:91 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunContext.md deleted file mode 100644 index 01eec0d08684ba..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunContext.md +++ /dev/null @@ -1,25 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RunContext - -# Interface: RunContext - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RunContext - -The run context is passed into a task's run function as its sole argument. - -## Table of contents - -### Properties - -- [taskInstance](client._internal_namespace.RunContext.md#taskinstance) - -## Properties - -### taskInstance - -• **taskInstance**: [`ConcreteTaskInstance`](client._internal_namespace.ConcreteTaskInstance.md) - -The document describing the task instance, its params, state, id, etc. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:23 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunNowResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunNowResult.md deleted file mode 100644 index d5a584a4b99c56..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunNowResult.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RunNowResult - -# Interface: RunNowResult - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RunNowResult - -## Table of contents - -### Properties - -- [id](client._internal_namespace.RunNowResult.md#id) -- [state](client._internal_namespace.RunNowResult.md#state) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_scheduling.d.ts:18 - -___ - -### state - -• `Optional` **state**: `Record`<`string`, `any`\> - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_scheduling.d.ts:19 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SSLSettings.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SSLSettings.md deleted file mode 100644 index ce1f83e9378765..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SSLSettings.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SSLSettings - -# Interface: SSLSettings - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SSLSettings - -## Table of contents - -### Properties - -- [verificationMode](client._internal_namespace.SSLSettings.md#verificationmode) - -## Properties - -### verificationMode - -• `Optional` **verificationMode**: ``"none"`` \| ``"certificate"`` \| ``"full"`` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:120 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObject.md deleted file mode 100644 index 7a2ab41e7cf9cc..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObject.md +++ /dev/null @@ -1,167 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObject - -# Interface: SavedObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObject - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- **`SavedObject`** - - ↳ [`SavedObjectsFindResult`](client._internal_namespace.SavedObjectsFindResult.md) - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.SavedObject.md#attributes) -- [coreMigrationVersion](client._internal_namespace.SavedObject.md#coremigrationversion) -- [error](client._internal_namespace.SavedObject.md#error) -- [id](client._internal_namespace.SavedObject.md#id) -- [migrationVersion](client._internal_namespace.SavedObject.md#migrationversion) -- [namespaces](client._internal_namespace.SavedObject.md#namespaces) -- [originId](client._internal_namespace.SavedObject.md#originid) -- [references](client._internal_namespace.SavedObject.md#references) -- [type](client._internal_namespace.SavedObject.md#type) -- [updated\_at](client._internal_namespace.SavedObject.md#updated_at) -- [version](client._internal_namespace.SavedObject.md#version) - -## Properties - -### attributes - -• **attributes**: `T` - -{@inheritdoc SavedObjectAttributes} - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:61 - -___ - -### coreMigrationVersion - -• `Optional` **coreMigrationVersion**: `string` - -A semver value that is used when upgrading objects between Kibana versions. - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:67 - -___ - -### error - -• `Optional` **error**: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:59 - -___ - -### id - -• **id**: `string` - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:52 - -___ - -### migrationVersion - -• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) - -{@inheritdoc SavedObjectsMigrationVersion} - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:65 - -___ - -### namespaces - -• `Optional` **namespaces**: `string`[] - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with -`namespaceType: 'agnostic'`. - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:72 - -___ - -### originId - -• `Optional` **originId**: `string` - -The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration -from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import -to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given -space. - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:79 - -___ - -### references - -• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -{@inheritdoc SavedObjectReference} - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:63 - -___ - -### type - -• **type**: `string` - -The type of Saved Object. Each plugin can define it's own custom Saved Object types. - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:54 - -___ - -### updated\_at - -• `Optional` **updated\_at**: `string` - -Timestamp of the last time this document had been updated. - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:58 - -___ - -### version - -• `Optional` **version**: `string` - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:56 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectAttributes.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectAttributes.md deleted file mode 100644 index 2f260171ce47af..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectAttributes.md +++ /dev/null @@ -1,20 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectAttributes - -# Interface: SavedObjectAttributes - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectAttributes - -The data for a Saved Object is stored as an object in the `attributes` -property. - -## Hierarchy - -- **`SavedObjectAttributes`** - - ↳ [`ActionUpdate`](client._internal_namespace.ActionUpdate.md) - - ↳ [`ConnectorToken`](client._internal_namespace.ConnectorToken.md) - -## Indexable - -▪ [key: `string`]: [`SavedObjectAttribute`](../modules/client._internal_namespace.md#savedobjectattribute) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectDoc.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectDoc.md deleted file mode 100644 index 50478fb7b3cf29..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectDoc.md +++ /dev/null @@ -1,128 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectDoc - -# Interface: SavedObjectDoc - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectDoc - -Saved Object base document - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.SavedObjectDoc.md#attributes) -- [coreMigrationVersion](client._internal_namespace.SavedObjectDoc.md#coremigrationversion) -- [id](client._internal_namespace.SavedObjectDoc.md#id) -- [migrationVersion](client._internal_namespace.SavedObjectDoc.md#migrationversion) -- [namespace](client._internal_namespace.SavedObjectDoc.md#namespace) -- [namespaces](client._internal_namespace.SavedObjectDoc.md#namespaces) -- [originId](client._internal_namespace.SavedObjectDoc.md#originid) -- [type](client._internal_namespace.SavedObjectDoc.md#type) -- [updated\_at](client._internal_namespace.SavedObjectDoc.md#updated_at) -- [version](client._internal_namespace.SavedObjectDoc.md#version) - -## Properties - -### attributes - -• **attributes**: `T` - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:28 - -___ - -### coreMigrationVersion - -• `Optional` **coreMigrationVersion**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:34 - -___ - -### id - -• **id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:29 - -___ - -### migrationVersion - -• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:33 - -___ - -### namespace - -• `Optional` **namespace**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:31 - -___ - -### namespaces - -• `Optional` **namespaces**: `string`[] - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:32 - -___ - -### originId - -• `Optional` **originId**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:37 - -___ - -### type - -• **type**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:30 - -___ - -### updated\_at - -• `Optional` **updated\_at**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:36 - -___ - -### version - -• `Optional` **version**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:35 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectError.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectError.md deleted file mode 100644 index 8b93bb038d5fa7..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectError.md +++ /dev/null @@ -1,54 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectError - -# Interface: SavedObjectError - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectError - -## Table of contents - -### Properties - -- [error](client._internal_namespace.SavedObjectError.md#error) -- [message](client._internal_namespace.SavedObjectError.md#message) -- [metadata](client._internal_namespace.SavedObjectError.md#metadata) -- [statusCode](client._internal_namespace.SavedObjectError.md#statuscode) - -## Properties - -### error - -• **error**: `string` - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:82 - -___ - -### message - -• **message**: `string` - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:83 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:85 - -___ - -### statusCode - -• **statusCode**: `number` - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:84 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationContext.md deleted file mode 100644 index b16816fc5ec40f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationContext.md +++ /dev/null @@ -1,64 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectMigrationContext - -# Interface: SavedObjectMigrationContext - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectMigrationContext - -Migration context provided when invoking a [migration handler](../modules/client._internal_namespace.md#savedobjectmigrationfn) - -## Table of contents - -### Properties - -- [convertToMultiNamespaceTypeVersion](client._internal_namespace.SavedObjectMigrationContext.md#converttomultinamespacetypeversion) -- [isSingleNamespaceType](client._internal_namespace.SavedObjectMigrationContext.md#issinglenamespacetype) -- [log](client._internal_namespace.SavedObjectMigrationContext.md#log) -- [migrationVersion](client._internal_namespace.SavedObjectMigrationContext.md#migrationversion) - -## Properties - -### convertToMultiNamespaceTypeVersion - -• `Optional` `Readonly` **convertToMultiNamespaceTypeVersion**: `string` - -The version in which this object type is being converted to a multi-namespace type - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/types.d.ts:57 - -___ - -### isSingleNamespaceType - -• `Readonly` **isSingleNamespaceType**: `boolean` - -Whether this is a single-namespace type or not - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/types.d.ts:61 - -___ - -### log - -• `Readonly` **log**: [`SavedObjectsMigrationLogger`](client._internal_namespace.SavedObjectsMigrationLogger.md) - -logger instance to be used by the migration handler - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/types.d.ts:49 - -___ - -### migrationVersion - -• `Readonly` **migrationVersion**: `string` - -The migration version that this migration function is defined for - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/types.d.ts:53 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationMap.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationMap.md deleted file mode 100644 index 2632e6259ff5b5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationMap.md +++ /dev/null @@ -1,23 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectMigrationMap - -# Interface: SavedObjectMigrationMap - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectMigrationMap - -A map of [migration functions](../modules/client._internal_namespace.md#savedobjectmigrationfn) to be used for a given type. -The map's keys must be valid semver versions, and they cannot exceed the current Kibana version. - -For a given document, only migrations with a higher version number than that of the document will be applied. -Migrations are executed in order, starting from the lowest version and ending with the highest one. - -**`example`** -```typescript -const migrationsMap: SavedObjectMigrationMap = { - '1.0.0': migrateToV1, - '2.1.0': migrateToV21 -} -``` - -## Indexable - -▪ [version: `string`]: [`SavedObjectMigrationFn`](../modules/client._internal_namespace.md#savedobjectmigrationfn)<`any`, `any`\> diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReference.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReference.md deleted file mode 100644 index 2c3f8ac1c7cc05..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReference.md +++ /dev/null @@ -1,45 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectReference - -# Interface: SavedObjectReference - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectReference - -A reference to another saved object. - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectReference.md#id) -- [name](client._internal_namespace.SavedObjectReference.md#name) -- [type](client._internal_namespace.SavedObjectReference.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:30 - -___ - -### name - -• **name**: `string` - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:28 - -___ - -### type - -• **type**: `string` - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:29 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md deleted file mode 100644 index 511e6aec3d9b60..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md +++ /dev/null @@ -1,91 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectReferenceWithContext - -# Interface: SavedObjectReferenceWithContext - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectReferenceWithContext - -A returned input object or one of its references, with additional context. - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectReferenceWithContext.md#id) -- [inboundReferences](client._internal_namespace.SavedObjectReferenceWithContext.md#inboundreferences) -- [isMissing](client._internal_namespace.SavedObjectReferenceWithContext.md#ismissing) -- [spaces](client._internal_namespace.SavedObjectReferenceWithContext.md#spaces) -- [spacesWithMatchingAliases](client._internal_namespace.SavedObjectReferenceWithContext.md#spaceswithmatchingaliases) -- [type](client._internal_namespace.SavedObjectReferenceWithContext.md#type) - -## Properties - -### id - -• **id**: `string` - -The ID of the referenced object - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:45 - -___ - -### inboundReferences - -• **inboundReferences**: { `id`: `string` ; `name`: `string` ; `type`: `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 - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:52 - -___ - -### isMissing - -• `Optional` **isMissing**: `boolean` - -Whether or not this object or reference is missing - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:61 - -___ - -### spaces - -• **spaces**: `string`[] - -The space(s) that the referenced object exists in - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:47 - -___ - -### spacesWithMatchingAliases - -• `Optional` **spacesWithMatchingAliases**: `string`[] - -The space(s) that legacy URL aliases matching this type/id exist in - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:63 - -___ - -### type - -• **type**: `string` - -The type of the referenced object - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:43 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBaseOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBaseOptions.md deleted file mode 100644 index afce23c52c88d9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBaseOptions.md +++ /dev/null @@ -1,47 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBaseOptions - -# Interface: SavedObjectsBaseOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBaseOptions - -## Hierarchy - -- **`SavedObjectsBaseOptions`** - - ↳ [`SavedObjectsRemoveReferencesToResponse`](client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md) - - ↳ [`SavedObjectsCreateOptions`](client._internal_namespace.SavedObjectsCreateOptions.md) - - ↳ [`SavedObjectsDeleteOptions`](client._internal_namespace.SavedObjectsDeleteOptions.md) - - ↳ [`SavedObjectsUpdateOptions`](client._internal_namespace.SavedObjectsUpdateOptions.md) - - ↳ [`SavedObjectsBulkUpdateOptions`](client._internal_namespace.SavedObjectsBulkUpdateOptions.md) - - ↳ [`SavedObjectsRemoveReferencesToOptions`](client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md) - - ↳ [`SavedObjectsCollectMultiNamespaceReferencesOptions`](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md) - - ↳ [`SavedObjectsUpdateObjectsSpacesOptions`](client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md) - - ↳ [`SavedObjectsDeleteByNamespaceOptions`](client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md) - - ↳ [`SavedObjectsIncrementCounterOptions`](client._internal_namespace.SavedObjectsIncrementCounterOptions.md) - -## Table of contents - -### Properties - -- [namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -## Properties - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md deleted file mode 100644 index 1a5bbd79801ba3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md +++ /dev/null @@ -1,136 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkCreateObject - -# Interface: SavedObjectsBulkCreateObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkCreateObject - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.SavedObjectsBulkCreateObject.md#attributes) -- [coreMigrationVersion](client._internal_namespace.SavedObjectsBulkCreateObject.md#coremigrationversion) -- [id](client._internal_namespace.SavedObjectsBulkCreateObject.md#id) -- [initialNamespaces](client._internal_namespace.SavedObjectsBulkCreateObject.md#initialnamespaces) -- [migrationVersion](client._internal_namespace.SavedObjectsBulkCreateObject.md#migrationversion) -- [originId](client._internal_namespace.SavedObjectsBulkCreateObject.md#originid) -- [references](client._internal_namespace.SavedObjectsBulkCreateObject.md#references) -- [type](client._internal_namespace.SavedObjectsBulkCreateObject.md#type) -- [version](client._internal_namespace.SavedObjectsBulkCreateObject.md#version) - -## Properties - -### attributes - -• **attributes**: `T` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:54 - -___ - -### coreMigrationVersion - -• `Optional` **coreMigrationVersion**: `string` - -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. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:68 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:52 - -___ - -### initialNamespaces - -• `Optional` **initialNamespaces**: `string`[] - -Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in -[SavedObjectsCreateOptions](client._internal_namespace.SavedObjectsCreateOptions.md). - -* 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. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:81 - -___ - -### migrationVersion - -• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) - -{@inheritDoc SavedObjectsMigrationVersion} - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:58 - -___ - -### originId - -• `Optional` **originId**: `string` - -Optional ID of the original saved object, if this object's `id` was regenerated - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:70 - -___ - -### references - -• `Optional` **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:56 - -___ - -### type - -• **type**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:53 - -___ - -### version - -• `Optional` **version**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:55 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md deleted file mode 100644 index 3b3dd0ecbc28bd..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md +++ /dev/null @@ -1,65 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkGetObject - -# Interface: SavedObjectsBulkGetObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkGetObject - -## Table of contents - -### Properties - -- [fields](client._internal_namespace.SavedObjectsBulkGetObject.md#fields) -- [id](client._internal_namespace.SavedObjectsBulkGetObject.md#id) -- [namespaces](client._internal_namespace.SavedObjectsBulkGetObject.md#namespaces) -- [type](client._internal_namespace.SavedObjectsBulkGetObject.md#type) - -## Properties - -### fields - -• `Optional` **fields**: `string`[] - -SavedObject fields to include in the response - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:239 - -___ - -### id - -• **id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:236 - -___ - -### namespaces - -• `Optional` **namespaces**: `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. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:250 - -___ - -### type - -• **type**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:237 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md deleted file mode 100644 index 56105f08768aed..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkResolveObject - -# Interface: SavedObjectsBulkResolveObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkResolveObject - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectsBulkResolveObject.md#id) -- [type](client._internal_namespace.SavedObjectsBulkResolveObject.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:279 - -___ - -### type - -• **type**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:280 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md deleted file mode 100644 index 4f7fc1463bb4b9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md +++ /dev/null @@ -1,27 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkResolveResponse - -# Interface: SavedObjectsBulkResolveResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkResolveResponse - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Table of contents - -### Properties - -- [resolved\_objects](client._internal_namespace.SavedObjectsBulkResolveResponse.md#resolved_objects) - -## Properties - -### resolved\_objects - -• **resolved\_objects**: [`SavedObjectsResolveResponse`](client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:287 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResponse.md deleted file mode 100644 index 76af857d6f612d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResponse.md +++ /dev/null @@ -1,27 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkResponse - -# Interface: SavedObjectsBulkResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkResponse - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Table of contents - -### Properties - -- [saved\_objects](client._internal_namespace.SavedObjectsBulkResponse.md#saved_objects) - -## Properties - -### saved\_objects - -• **saved\_objects**: [`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\>[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:107 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md deleted file mode 100644 index f0ae9c5aa503f9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md +++ /dev/null @@ -1,111 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkUpdateObject - -# Interface: SavedObjectsBulkUpdateObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkUpdateObject - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- `Pick`<[`SavedObjectsUpdateOptions`](client._internal_namespace.SavedObjectsUpdateOptions.md)<`T`\>, ``"version"`` \| ``"references"``\> - - ↳ **`SavedObjectsBulkUpdateObject`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.SavedObjectsBulkUpdateObject.md#attributes) -- [id](client._internal_namespace.SavedObjectsBulkUpdateObject.md#id) -- [namespace](client._internal_namespace.SavedObjectsBulkUpdateObject.md#namespace) -- [references](client._internal_namespace.SavedObjectsBulkUpdateObject.md#references) -- [type](client._internal_namespace.SavedObjectsBulkUpdateObject.md#type) -- [version](client._internal_namespace.SavedObjectsBulkUpdateObject.md#version) - -## Properties - -### attributes - -• **attributes**: `Partial`<`T`\> - -{@inheritdoc SavedObjectAttributes} - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:93 - -___ - -### id - -• **id**: `string` - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:89 - -___ - -### namespace - -• `Optional` **namespace**: `string` - -Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in -[SavedObjectsBulkUpdateOptions](client._internal_namespace.SavedObjectsBulkUpdateOptions.md). - -Note: the default namespace's string representation is `'default'`, and its ID representation is `undefined`. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:100 - -___ - -### references - -• `Optional` **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -{@inheritdoc SavedObjectReference} - -#### Inherited from - -Pick.references - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:191 - -___ - -### type - -• **type**: `string` - -The type of this Saved Object. Each plugin can define it's own custom Saved Object types. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:91 - -___ - -### version - -• `Optional` **version**: `string` - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -#### Inherited from - -Pick.version - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:189 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md deleted file mode 100644 index 4de3a8eefdb023..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md +++ /dev/null @@ -1,46 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkUpdateOptions - -# Interface: SavedObjectsBulkUpdateOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkUpdateOptions - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsBulkUpdateOptions`** - -## Table of contents - -### Properties - -- [namespace](client._internal_namespace.SavedObjectsBulkUpdateOptions.md#namespace) -- [refresh](client._internal_namespace.SavedObjectsBulkUpdateOptions.md#refresh) - -## Properties - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### refresh - -• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) - -The Elasticsearch Refresh setting for this operation - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:219 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md deleted file mode 100644 index 93fb3c3f3a3b22..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md +++ /dev/null @@ -1,27 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkUpdateResponse - -# Interface: SavedObjectsBulkUpdateResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkUpdateResponse - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Table of contents - -### Properties - -- [saved\_objects](client._internal_namespace.SavedObjectsBulkUpdateResponse.md#saved_objects) - -## Properties - -### saved\_objects - -• **saved\_objects**: [`SavedObjectsUpdateResponse`](client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:264 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md deleted file mode 100644 index 7b8a8b1b6982fb..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCheckConflictsObject - -# Interface: SavedObjectsCheckConflictsObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCheckConflictsObject - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectsCheckConflictsObject.md#id) -- [type](client._internal_namespace.SavedObjectsCheckConflictsObject.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:169 - -___ - -### type - -• **type**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:170 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md deleted file mode 100644 index d43f929a18feda..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCheckConflictsResponse - -# Interface: SavedObjectsCheckConflictsResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCheckConflictsResponse - -## Table of contents - -### Properties - -- [errors](client._internal_namespace.SavedObjectsCheckConflictsResponse.md#errors) - -## Properties - -### errors - -• **errors**: { `error`: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) ; `id`: `string` ; `type`: `string` }[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:177 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md deleted file mode 100644 index acf9af85bdc20d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md +++ /dev/null @@ -1,37 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsClosePointInTimeResponse - -# Interface: SavedObjectsClosePointInTimeResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsClosePointInTimeResponse - -## Table of contents - -### Properties - -- [num\_freed](client._internal_namespace.SavedObjectsClosePointInTimeResponse.md#num_freed) -- [succeeded](client._internal_namespace.SavedObjectsClosePointInTimeResponse.md#succeeded) - -## Properties - -### num\_freed - -• **num\_freed**: `number` - -The number of search contexts that have been successfully closed. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:360 - -___ - -### succeeded - -• **succeeded**: `boolean` - -If true, all search contexts associated with the PIT id are -successfully closed. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:356 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md deleted file mode 100644 index 7db1c04858eb34..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCollectMultiNamespaceReferencesObject - -# Interface: SavedObjectsCollectMultiNamespaceReferencesObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCollectMultiNamespaceReferencesObject - -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'`). - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md#id) -- [type](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:24 - -___ - -### type - -• **type**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:25 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md deleted file mode 100644 index 32ffe4158cc00b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md +++ /dev/null @@ -1,48 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCollectMultiNamespaceReferencesOptions - -# Interface: SavedObjectsCollectMultiNamespaceReferencesOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCollectMultiNamespaceReferencesOptions - -Options for collecting references. - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsCollectMultiNamespaceReferencesOptions`** - -## Table of contents - -### Properties - -- [namespace](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md#namespace) -- [purpose](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md#purpose) - -## Properties - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### purpose - -• `Optional` **purpose**: ``"collectMultiNamespaceReferences"`` \| ``"updateObjectsSpaces"`` - -Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences' - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:34 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md deleted file mode 100644 index 768ce8c1c60940..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md +++ /dev/null @@ -1,23 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCollectMultiNamespaceReferencesResponse - -# Interface: SavedObjectsCollectMultiNamespaceReferencesResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCollectMultiNamespaceReferencesResponse - -The response when object references are collected. - -## Table of contents - -### Properties - -- [objects](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md#objects) - -## Properties - -### objects - -• **objects**: [`SavedObjectReferenceWithContext`](client._internal_namespace.SavedObjectReferenceWithContext.md)[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:71 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreateOptions.md deleted file mode 100644 index d2b13605808ac7..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreateOptions.md +++ /dev/null @@ -1,162 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCreateOptions - -# Interface: SavedObjectsCreateOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCreateOptions - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsCreateOptions`** - -## Table of contents - -### Properties - -- [coreMigrationVersion](client._internal_namespace.SavedObjectsCreateOptions.md#coremigrationversion) -- [id](client._internal_namespace.SavedObjectsCreateOptions.md#id) -- [initialNamespaces](client._internal_namespace.SavedObjectsCreateOptions.md#initialnamespaces) -- [migrationVersion](client._internal_namespace.SavedObjectsCreateOptions.md#migrationversion) -- [namespace](client._internal_namespace.SavedObjectsCreateOptions.md#namespace) -- [originId](client._internal_namespace.SavedObjectsCreateOptions.md#originid) -- [overwrite](client._internal_namespace.SavedObjectsCreateOptions.md#overwrite) -- [references](client._internal_namespace.SavedObjectsCreateOptions.md#references) -- [refresh](client._internal_namespace.SavedObjectsCreateOptions.md#refresh) -- [version](client._internal_namespace.SavedObjectsCreateOptions.md#version) - -## Properties - -### coreMigrationVersion - -• `Optional` **coreMigrationVersion**: `string` - -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. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:29 - -___ - -### id - -• `Optional` **id**: `string` - -(not recommended) Specify an id for the document - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:10 - -___ - -### initialNamespaces - -• `Optional` **initialNamespaces**: `string`[] - -Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in -[SavedObjectsCreateOptions](client._internal_namespace.SavedObjectsCreateOptions.md). - -* 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. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:45 - -___ - -### migrationVersion - -• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) - -{@inheritDoc SavedObjectsMigrationVersion} - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:19 - -___ - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### originId - -• `Optional` **originId**: `string` - -Optional ID of the original saved object, if this object's `id` was regenerated - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:34 - -___ - -### overwrite - -• `Optional` **overwrite**: `boolean` - -Overwrite existing documents (defaults to false) - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:12 - -___ - -### references - -• `Optional` **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:30 - -___ - -### refresh - -• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) - -The Elasticsearch Refresh setting for this operation - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:32 - -___ - -### version - -• `Optional` **version**: `string` - -An opaque version number which changes on each successful write operation. -Can be used in conjunction with `overwrite` for implementing optimistic concurrency control. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:17 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md deleted file mode 100644 index 3289e3cb4144f5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCreatePointInTimeFinderDependencies - -# Interface: SavedObjectsCreatePointInTimeFinderDependencies - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCreatePointInTimeFinderDependencies - -## Table of contents - -### Properties - -- [client](client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md#client) - -## Properties - -### client - -• **client**: `Pick`<[`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract), ``"find"`` \| ``"openPointInTimeForType"`` \| ``"closePointInTime"``\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/point_in_time_finder.d.ts:12 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md deleted file mode 100644 index 17fa13e76ec5fe..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md +++ /dev/null @@ -1,46 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsDeleteByNamespaceOptions - -# Interface: SavedObjectsDeleteByNamespaceOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsDeleteByNamespaceOptions - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsDeleteByNamespaceOptions`** - -## Table of contents - -### Properties - -- [namespace](client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md#namespace) -- [refresh](client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md#refresh) - -## Properties - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### refresh - -• `Optional` **refresh**: `boolean` - -The Elasticsearch supports only boolean flag for this operation - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:49 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md deleted file mode 100644 index 21bd9feec57cff..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md +++ /dev/null @@ -1,59 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsDeleteOptions - -# Interface: SavedObjectsDeleteOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsDeleteOptions - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsDeleteOptions`** - -## Table of contents - -### Properties - -- [force](client._internal_namespace.SavedObjectsDeleteOptions.md#force) -- [namespace](client._internal_namespace.SavedObjectsDeleteOptions.md#namespace) -- [refresh](client._internal_namespace.SavedObjectsDeleteOptions.md#refresh) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -Force deletion of an object that exists in multiple namespaces - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:229 - -___ - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### refresh - -• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) - -The Elasticsearch Refresh setting for this operation - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:227 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md deleted file mode 100644 index 2b82cecc98091e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md +++ /dev/null @@ -1,26 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsExportTransformContext - -# Interface: SavedObjectsExportTransformContext - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsExportTransformContext - -Context passed down to a [export transform function](../modules/client._internal_namespace.md#savedobjectsexporttransform) - -## Table of contents - -### Properties - -- [request](client._internal_namespace.SavedObjectsExportTransformContext.md#request) - -## Properties - -### request - -• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> - -The request that initiated the export request. Can be used to create scoped -services or client inside the [transformation](../modules/client._internal_namespace.md#savedobjectsexporttransform) - -#### Defined in - -src/core/target/types/server/saved_objects/export/types.d.ts:87 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptions.md deleted file mode 100644 index 1cc767734ce555..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptions.md +++ /dev/null @@ -1,270 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsFindOptions - -# Interface: SavedObjectsFindOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsFindOptions - -## Table of contents - -### Properties - -- [aggs](client._internal_namespace.SavedObjectsFindOptions.md#aggs) -- [defaultSearchOperator](client._internal_namespace.SavedObjectsFindOptions.md#defaultsearchoperator) -- [fields](client._internal_namespace.SavedObjectsFindOptions.md#fields) -- [filter](client._internal_namespace.SavedObjectsFindOptions.md#filter) -- [hasReference](client._internal_namespace.SavedObjectsFindOptions.md#hasreference) -- [hasReferenceOperator](client._internal_namespace.SavedObjectsFindOptions.md#hasreferenceoperator) -- [namespaces](client._internal_namespace.SavedObjectsFindOptions.md#namespaces) -- [page](client._internal_namespace.SavedObjectsFindOptions.md#page) -- [perPage](client._internal_namespace.SavedObjectsFindOptions.md#perpage) -- [pit](client._internal_namespace.SavedObjectsFindOptions.md#pit) -- [preference](client._internal_namespace.SavedObjectsFindOptions.md#preference) -- [rootSearchFields](client._internal_namespace.SavedObjectsFindOptions.md#rootsearchfields) -- [search](client._internal_namespace.SavedObjectsFindOptions.md#search) -- [searchAfter](client._internal_namespace.SavedObjectsFindOptions.md#searchafter) -- [searchFields](client._internal_namespace.SavedObjectsFindOptions.md#searchfields) -- [sortField](client._internal_namespace.SavedObjectsFindOptions.md#sortfield) -- [sortOrder](client._internal_namespace.SavedObjectsFindOptions.md#sortorder) -- [type](client._internal_namespace.SavedObjectsFindOptions.md#type) -- [typeToNamespacesMap](client._internal_namespace.SavedObjectsFindOptions.md#typetonamespacesmap) - -## Properties - -### aggs - -• `Optional` **aggs**: `Record`<`string`, `AggregationsAggregationContainer`\> - -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`** - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:103 - -___ - -### defaultSearchOperator - -• `Optional` **defaultSearchOperator**: ``"AND"`` \| ``"OR"`` - -The search operator to use with the provided filter. Defaults to `OR` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:80 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -An array of fields to include in the results - -**`example`** -SavedObjects.find({type: 'dashboard', fields: ['attributes.name', 'attributes.location']}) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:54 - -___ - -### filter - -• `Optional` **filter**: `any` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:81 - -___ - -### hasReference - -• `Optional` **hasReference**: [`SavedObjectsFindOptionsReference`](client._internal_namespace.SavedObjectsFindOptionsReference.md) \| [`SavedObjectsFindOptionsReference`](client._internal_namespace.SavedObjectsFindOptionsReference.md)[] - -Search for documents having a reference to the specified objects. -Use `hasReferenceOperator` to specify the operator to use when searching for multiple references. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:72 - -___ - -### hasReferenceOperator - -• `Optional` **hasReferenceOperator**: ``"AND"`` \| ``"OR"`` - -The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:76 - -___ - -### namespaces - -• `Optional` **namespaces**: `string`[] - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:104 - -___ - -### page - -• `Optional` **page**: `number` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:45 - -___ - -### perPage - -• `Optional` **perPage**: `number` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:46 - -___ - -### pit - -• `Optional` **pit**: [`SavedObjectsPitParams`](client._internal_namespace.SavedObjectsPitParams.md) - -Search against a specific Point In Time (PIT) that you've opened with [SavedObjectsClient.openPointInTimeForType](../classes/client._internal_namespace.SavedObjectsClient.md#openpointintimefortype). - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:118 - -___ - -### preference - -• `Optional` **preference**: `string` - -An optional ES preference value to be used for the query - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:114 - -___ - -### rootSearchFields - -• `Optional` **rootSearchFields**: `string`[] - -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. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:67 - -___ - -### search - -• `Optional` **search**: `string` - -Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:56 - -___ - -### searchAfter - -• `Optional` **searchAfter**: `string`[] - -Use the sort values from the previous page to retrieve the next page of results. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:62 - -___ - -### searchFields - -• `Optional` **searchFields**: `string`[] - -The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:58 - -___ - -### sortField - -• `Optional` **sortField**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:47 - -___ - -### sortOrder - -• `Optional` **sortOrder**: `SortOrder` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:48 - -___ - -### type - -• **type**: `string` \| `string`[] - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:44 - -___ - -### typeToNamespacesMap - -• `Optional` **typeToNamespacesMap**: `Map`<`string`, `undefined` \| `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. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:112 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md deleted file mode 100644 index dd1f782c26b7dd..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsFindOptionsReference - -# Interface: SavedObjectsFindOptionsReference - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsFindOptionsReference - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectsFindOptionsReference.md#id) -- [type](client._internal_namespace.SavedObjectsFindOptionsReference.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:30 - -___ - -### type - -• **type**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:29 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResponse.md deleted file mode 100644 index 5fd16ec67e7811..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResponse.md +++ /dev/null @@ -1,88 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsFindResponse - -# Interface: SavedObjectsFindResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsFindResponse - -Return type of the Saved Objects `find()` method. - -*Note*: this type is different between the Public and Server Saved Objects -clients. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | -| `A` | `unknown` | - -## Table of contents - -### Properties - -- [aggregations](client._internal_namespace.SavedObjectsFindResponse.md#aggregations) -- [page](client._internal_namespace.SavedObjectsFindResponse.md#page) -- [per\_page](client._internal_namespace.SavedObjectsFindResponse.md#per_page) -- [pit\_id](client._internal_namespace.SavedObjectsFindResponse.md#pit_id) -- [saved\_objects](client._internal_namespace.SavedObjectsFindResponse.md#saved_objects) -- [total](client._internal_namespace.SavedObjectsFindResponse.md#total) - -## Properties - -### aggregations - -• `Optional` **aggregations**: `A` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:157 - -___ - -### page - -• **page**: `number` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:161 - -___ - -### per\_page - -• **per\_page**: `number` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:160 - -___ - -### pit\_id - -• `Optional` **pit\_id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:162 - -___ - -### saved\_objects - -• **saved\_objects**: [`SavedObjectsFindResult`](client._internal_namespace.SavedObjectsFindResult.md)<`T`\>[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:158 - -___ - -### total - -• **total**: `number` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:159 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResult.md deleted file mode 100644 index aa7578f7daaa60..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResult.md +++ /dev/null @@ -1,262 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsFindResult - -# Interface: SavedObjectsFindResult - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsFindResult - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- [`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\> - - ↳ **`SavedObjectsFindResult`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.SavedObjectsFindResult.md#attributes) -- [coreMigrationVersion](client._internal_namespace.SavedObjectsFindResult.md#coremigrationversion) -- [error](client._internal_namespace.SavedObjectsFindResult.md#error) -- [id](client._internal_namespace.SavedObjectsFindResult.md#id) -- [migrationVersion](client._internal_namespace.SavedObjectsFindResult.md#migrationversion) -- [namespaces](client._internal_namespace.SavedObjectsFindResult.md#namespaces) -- [originId](client._internal_namespace.SavedObjectsFindResult.md#originid) -- [references](client._internal_namespace.SavedObjectsFindResult.md#references) -- [score](client._internal_namespace.SavedObjectsFindResult.md#score) -- [sort](client._internal_namespace.SavedObjectsFindResult.md#sort) -- [type](client._internal_namespace.SavedObjectsFindResult.md#type) -- [updated\_at](client._internal_namespace.SavedObjectsFindResult.md#updated_at) -- [version](client._internal_namespace.SavedObjectsFindResult.md#version) - -## Properties - -### attributes - -• **attributes**: `T` - -{@inheritdoc SavedObjectAttributes} - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[attributes](client._internal_namespace.SavedObject.md#attributes) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:61 - -___ - -### coreMigrationVersion - -• `Optional` **coreMigrationVersion**: `string` - -A semver value that is used when upgrading objects between Kibana versions. - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[coreMigrationVersion](client._internal_namespace.SavedObject.md#coremigrationversion) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:67 - -___ - -### error - -• `Optional` **error**: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[error](client._internal_namespace.SavedObject.md#error) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:59 - -___ - -### id - -• **id**: `string` - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[id](client._internal_namespace.SavedObject.md#id) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:52 - -___ - -### migrationVersion - -• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) - -{@inheritdoc SavedObjectsMigrationVersion} - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[migrationVersion](client._internal_namespace.SavedObject.md#migrationversion) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:65 - -___ - -### namespaces - -• `Optional` **namespaces**: `string`[] - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with -`namespaceType: 'agnostic'`. - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[namespaces](client._internal_namespace.SavedObject.md#namespaces) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:72 - -___ - -### originId - -• `Optional` **originId**: `string` - -The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration -from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import -to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given -space. - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[originId](client._internal_namespace.SavedObject.md#originid) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:79 - -___ - -### references - -• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -{@inheritdoc SavedObjectReference} - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[references](client._internal_namespace.SavedObject.md#references) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:63 - -___ - -### score - -• **score**: `number` - -The Elasticsearch `_score` of this result. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:117 - -___ - -### sort - -• `Optional` **sort**: `string`[] - -The Elasticsearch `sort` value of this result. - -**`remarks`** -This can be passed directly to the `searchAfter` param in the [SavedObjectsFindOptions](client._internal_namespace.SavedObjectsFindOptions.md) -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 [SavedObjectsClient.openPointInTimeForType](../classes/client._internal_namespace.SavedObjectsClient.md#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); -``` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:146 - -___ - -### type - -• **type**: `string` - -The type of Saved Object. Each plugin can define it's own custom Saved Object types. - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[type](client._internal_namespace.SavedObject.md#type) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:54 - -___ - -### updated\_at - -• `Optional` **updated\_at**: `string` - -Timestamp of the last time this document had been updated. - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[updated_at](client._internal_namespace.SavedObject.md#updated_at) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:58 - -___ - -### version - -• `Optional` **version**: `string` - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -#### Inherited from - -[SavedObject](client._internal_namespace.SavedObject.md).[version](client._internal_namespace.SavedObject.md#version) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:56 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md deleted file mode 100644 index e2996e270116e7..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md +++ /dev/null @@ -1,65 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsImportActionRequiredWarning - -# Interface: SavedObjectsImportActionRequiredWarning - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsImportActionRequiredWarning - -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. - -## Table of contents - -### Properties - -- [actionPath](client._internal_namespace.SavedObjectsImportActionRequiredWarning.md#actionpath) -- [buttonLabel](client._internal_namespace.SavedObjectsImportActionRequiredWarning.md#buttonlabel) -- [message](client._internal_namespace.SavedObjectsImportActionRequiredWarning.md#message) -- [type](client._internal_namespace.SavedObjectsImportActionRequiredWarning.md#type) - -## Properties - -### actionPath - -• **actionPath**: `string` - -The path (without the basePath) that the user should be redirect to address this warning. - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:191 - -___ - -### buttonLabel - -• `Optional` **buttonLabel**: `string` - -An optional label to use for the link button. If unspecified, a default label will be used. - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:193 - -___ - -### message - -• **message**: `string` - -The translated message to display to the user. - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:189 - -___ - -### type - -• **type**: ``"action_required"`` - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:187 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportHookResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportHookResult.md deleted file mode 100644 index 37e2cbd5d788b3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportHookResult.md +++ /dev/null @@ -1,25 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsImportHookResult - -# Interface: SavedObjectsImportHookResult - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsImportHookResult - -Result from a [import hook](../modules/client._internal_namespace.md#savedobjectsimporthook) - -## Table of contents - -### Properties - -- [warnings](client._internal_namespace.SavedObjectsImportHookResult.md#warnings) - -## Properties - -### warnings - -• `Optional` **warnings**: [`SavedObjectsImportWarning`](../modules/client._internal_namespace.md#savedobjectsimportwarning)[] - -An optional list of warnings to display in the UI when the import succeeds. - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:213 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md deleted file mode 100644 index 55f2c60462af41..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md +++ /dev/null @@ -1,36 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsImportSimpleWarning - -# Interface: SavedObjectsImportSimpleWarning - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsImportSimpleWarning - -A simple informative warning that will be displayed to the user. - -## Table of contents - -### Properties - -- [message](client._internal_namespace.SavedObjectsImportSimpleWarning.md#message) -- [type](client._internal_namespace.SavedObjectsImportSimpleWarning.md#type) - -## Properties - -### message - -• **message**: `string` - -The translated message to display to the user - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:176 - -___ - -### type - -• **type**: ``"simple"`` - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:174 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md deleted file mode 100644 index b2158482436594..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md +++ /dev/null @@ -1,36 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsIncrementCounterField - -# Interface: SavedObjectsIncrementCounterField - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsIncrementCounterField - -## Table of contents - -### Properties - -- [fieldName](client._internal_namespace.SavedObjectsIncrementCounterField.md#fieldname) -- [incrementBy](client._internal_namespace.SavedObjectsIncrementCounterField.md#incrementby) - -## Properties - -### fieldName - -• **fieldName**: `string` - -The field name to increment the counter by. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:63 - -___ - -### incrementBy - -• `Optional` **incrementBy**: `number` - -The number to increment the field by (defaults to 1). - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:65 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md deleted file mode 100644 index ce239bd55e5c2f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md +++ /dev/null @@ -1,93 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsIncrementCounterOptions - -# Interface: SavedObjectsIncrementCounterOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsIncrementCounterOptions - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Attributes` | `unknown` | - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsIncrementCounterOptions`** - -## Table of contents - -### Properties - -- [initialize](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#initialize) -- [migrationVersion](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#migrationversion) -- [namespace](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#namespace) -- [refresh](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#refresh) -- [upsertAttributes](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#upsertattributes) - -## Properties - -### initialize - -• `Optional` **initialize**: `boolean` - -(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. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:30 - -___ - -### migrationVersion - -• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) - -[SavedObjectsMigrationVersion](client._internal_namespace.SavedObjectsMigrationVersion.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:32 - -___ - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### refresh - -• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) - -(default='wait_for') The Elasticsearch refresh setting for this -operation. See [MutatingOperationRefreshSetting](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:37 - -___ - -### upsertAttributes - -• `Optional` **upsertAttributes**: `Attributes` - -Attributes to use when upserting the document if it doesn't exist. - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:41 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMappingProperties.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMappingProperties.md deleted file mode 100644 index 5dca5a908c566d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMappingProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsMappingProperties - -# Interface: SavedObjectsMappingProperties - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsMappingProperties - -Describe the fields of a [saved object type](client._internal_namespace.SavedObjectsTypeMappingDefinition.md). - -## Indexable - -▪ [field: `string`]: [`SavedObjectsFieldMapping`](../modules/client._internal_namespace.md#savedobjectsfieldmapping) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md deleted file mode 100644 index 399885d1ab4ae6..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md +++ /dev/null @@ -1,124 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsMigrationLogger - -# Interface: SavedObjectsMigrationLogger - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsMigrationLogger - -## Table of contents - -### Methods - -- [debug](client._internal_namespace.SavedObjectsMigrationLogger.md#debug) -- [error](client._internal_namespace.SavedObjectsMigrationLogger.md#error) -- [info](client._internal_namespace.SavedObjectsMigrationLogger.md#info) -- [warn](client._internal_namespace.SavedObjectsMigrationLogger.md#warn) -- [warning](client._internal_namespace.SavedObjectsMigrationLogger.md#warning) - -## Methods - -### debug - -▸ **debug**(`msg`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `msg` | `string` | - -#### Returns - -`void` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:5 - -___ - -### error - -▸ **error**<`Meta`\>(`msg`, `meta`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Meta` | extends `LogMeta` = `LogMeta` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `msg` | `string` | -| `meta` | `Meta` | - -#### Returns - -`void` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:12 - -___ - -### info - -▸ **info**(`msg`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `msg` | `string` | - -#### Returns - -`void` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:6 - -___ - -### warn - -▸ **warn**(`msg`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `msg` | `string` | - -#### Returns - -`void` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:11 - -___ - -### warning - -▸ **warning**(`msg`): `void` - -**`deprecated`** Use `warn` instead. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `msg` | `string` | - -#### Returns - -`void` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:10 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md deleted file mode 100644 index deee7313ee96b0..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsMigrationVersion - -# Interface: SavedObjectsMigrationVersion - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsMigrationVersion - -Information about the migrations that have been applied to this SavedObject. -When Kibana starts up, KibanaMigrator detects outdated documents and -migrates them based on this value. For each migration that has been applied, -the plugin's name is used as a key and the latest migration version as the -value. - -**`example`** -migrationVersion: { - dashboard: '7.1.1', - space: '6.6.6', -} - -## Indexable - -▪ [pluginName: `string`]: `string` diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md deleted file mode 100644 index 1b5d7dd5c90eaa..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md +++ /dev/null @@ -1,54 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsOpenPointInTimeOptions - -# Interface: SavedObjectsOpenPointInTimeOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsOpenPointInTimeOptions - -## Table of contents - -### Properties - -- [keepAlive](client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md#keepalive) -- [namespaces](client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md#namespaces) -- [preference](client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md#preference) - -## Properties - -### keepAlive - -• `Optional` **keepAlive**: `string` - -Optionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:320 - -___ - -### namespaces - -• `Optional` **namespaces**: `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 - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:333 - -___ - -### preference - -• `Optional` **preference**: `string` - -An optional ES preference value to be used for the query. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:324 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md deleted file mode 100644 index 22718b1c3177c4..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md +++ /dev/null @@ -1,23 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsOpenPointInTimeResponse - -# Interface: SavedObjectsOpenPointInTimeResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsOpenPointInTimeResponse - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md#id) - -## Properties - -### id - -• **id**: `string` - -PIT ID returned from ES. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:342 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsPitParams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsPitParams.md deleted file mode 100644 index 0c2d6fdc1cc4e3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsPitParams.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsPitParams - -# Interface: SavedObjectsPitParams - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsPitParams - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectsPitParams.md#id) -- [keepAlive](client._internal_namespace.SavedObjectsPitParams.md#keepalive) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:36 - -___ - -### keepAlive - -• `Optional` **keepAlive**: `string` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:37 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md deleted file mode 100644 index 79de02623cf8a8..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md +++ /dev/null @@ -1,46 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsRemoveReferencesToOptions - -# Interface: SavedObjectsRemoveReferencesToOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsRemoveReferencesToOptions - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsRemoveReferencesToOptions`** - -## Table of contents - -### Properties - -- [namespace](client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md#namespace) -- [refresh](client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md#refresh) - -## Properties - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### refresh - -• `Optional` **refresh**: `boolean` - -The Elasticsearch Refresh setting for this operation. Defaults to `true` - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:203 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md deleted file mode 100644 index c6d285307c99d5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md +++ /dev/null @@ -1,46 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsRemoveReferencesToResponse - -# Interface: SavedObjectsRemoveReferencesToResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsRemoveReferencesToResponse - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsRemoveReferencesToResponse`** - -## Table of contents - -### Properties - -- [namespace](client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md#namespace) -- [updated](client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md#updated) - -## Properties - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### updated - -• **updated**: `number` - -The number of objects that have been updated by this operation - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:211 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsResolveResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsResolveResponse.md deleted file mode 100644 index a4d66d064bf631..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsResolveResponse.md +++ /dev/null @@ -1,61 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsResolveResponse - -# Interface: SavedObjectsResolveResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsResolveResponse - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Table of contents - -### Properties - -- [alias\_target\_id](client._internal_namespace.SavedObjectsResolveResponse.md#alias_target_id) -- [outcome](client._internal_namespace.SavedObjectsResolveResponse.md#outcome) -- [saved\_object](client._internal_namespace.SavedObjectsResolveResponse.md#saved_object) - -## Properties - -### alias\_target\_id - -• `Optional` **alias\_target\_id**: `string` - -The ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:311 - -___ - -### outcome - -• **outcome**: ``"exactMatch"`` \| ``"aliasMatch"`` \| ``"conflict"`` - -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. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:307 - -___ - -### saved\_object - -• **saved\_object**: [`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\> - -The saved object that was found. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:297 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsType.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsType.md deleted file mode 100644 index b211135fc93ac1..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsType.md +++ /dev/null @@ -1,212 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsType - -# Interface: SavedObjectsType - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsType - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Attributes` | `any` | - -## Table of contents - -### Properties - -- [convertToAliasScript](client._internal_namespace.SavedObjectsType.md#converttoaliasscript) -- [convertToMultiNamespaceTypeVersion](client._internal_namespace.SavedObjectsType.md#converttomultinamespacetypeversion) -- [excludeOnUpgrade](client._internal_namespace.SavedObjectsType.md#excludeonupgrade) -- [hidden](client._internal_namespace.SavedObjectsType.md#hidden) -- [indexPattern](client._internal_namespace.SavedObjectsType.md#indexpattern) -- [management](client._internal_namespace.SavedObjectsType.md#management) -- [mappings](client._internal_namespace.SavedObjectsType.md#mappings) -- [migrations](client._internal_namespace.SavedObjectsType.md#migrations) -- [name](client._internal_namespace.SavedObjectsType.md#name) -- [namespaceType](client._internal_namespace.SavedObjectsType.md#namespacetype) -- [schemas](client._internal_namespace.SavedObjectsType.md#schemas) - -## Properties - -### convertToAliasScript - -• `Optional` **convertToAliasScript**: `string` - -If defined, will be used to convert the type to an alias. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:235 - -___ - -### convertToMultiNamespaceTypeVersion - -• `Optional` **convertToMultiNamespaceTypeVersion**: `string` - -If defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this -version. - -Requirements: - - 1. This string value must be a valid semver version - 2. This type must have previously specified [`namespaceType: 'single'`](../modules/client._internal_namespace.md#savedobjectsnamespacetype) - 3. This type must also specify [`namespaceType: 'multiple'`](../modules/client._internal_namespace.md#savedobjectsnamespacetype) *or* - [`namespaceType: 'multiple-isolated'`](../modules/client._internal_namespace.md#savedobjectsnamespacetype) - -Example of a single-namespace type in 7.12: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'single', - mappings: {...} -} -``` - -Example after converting to a multi-namespace (isolated) type in 8.0: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple-isolated', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` - -Example after converting to a multi-namespace (shareable) type in 8.1: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` - -Note: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:305 - -___ - -### excludeOnUpgrade - -• `Optional` **excludeOnUpgrade**: [`SavedObjectTypeExcludeFromUpgradeFilterHook`](../modules/client._internal_namespace.md#savedobjecttypeexcludefromupgradefilterhook) - -If defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted. -See [SavedObjectTypeExcludeFromUpgradeFilterHook](../modules/client._internal_namespace.md#savedobjecttypeexcludefromupgradefilterhook) for more details. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:240 - -___ - -### hidden - -• **hidden**: `boolean` - -Is the type hidden by default. If true, repositories will not have access to this type unless explicitly -declared as an `extraType` when creating the repository. - -See {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:223 - -___ - -### indexPattern - -• `Optional` **indexPattern**: `string` - -If defined, the type instances will be stored in the given index instead of the default one. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:231 - -___ - -### management - -• `Optional` **management**: [`SavedObjectsTypeManagementDefinition`](client._internal_namespace.SavedObjectsTypeManagementDefinition.md)<`Attributes`\> - -An optional [saved objects management section](client._internal_namespace.SavedObjectsTypeManagementDefinition.md) definition for the type. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:309 - -___ - -### mappings - -• **mappings**: [`SavedObjectsTypeMappingDefinition`](client._internal_namespace.SavedObjectsTypeMappingDefinition.md) - -The [mapping definition](client._internal_namespace.SavedObjectsTypeMappingDefinition.md) for the type. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:244 - -___ - -### migrations - -• `Optional` **migrations**: [`SavedObjectMigrationMap`](client._internal_namespace.SavedObjectMigrationMap.md) \| () => [`SavedObjectMigrationMap`](client._internal_namespace.SavedObjectMigrationMap.md) - -An optional map of [migrations](../modules/client._internal_namespace.md#savedobjectmigrationfn) or a function returning a map of [migrations](../modules/client._internal_namespace.md#savedobjectmigrationfn) to be used to migrate the type. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:248 - -___ - -### name - -• **name**: `string` - -The name of the type, which is also used as the internal id. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:216 - -___ - -### namespaceType - -• **namespaceType**: [`SavedObjectsNamespaceType`](../modules/client._internal_namespace.md#savedobjectsnamespacetype) - -The [namespace type](../modules/client._internal_namespace.md#savedobjectsnamespacetype) for the type. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:227 - -___ - -### schemas - -• `Optional` **schemas**: [`SavedObjectsValidationMap`](client._internal_namespace.SavedObjectsValidationMap.md) \| () => [`SavedObjectsValidationMap`](client._internal_namespace.SavedObjectsValidationMap.md) - -An optional schema that can be used to validate the attributes of the type. - -When provided, calls to [create](../classes/client._internal_namespace.SavedObjectsClient.md#create) will be validated against this schema. - -See [SavedObjectsValidationMap](client._internal_namespace.SavedObjectsValidationMap.md) for more details. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:256 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md deleted file mode 100644 index 4c9f9b93422155..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md +++ /dev/null @@ -1,299 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsTypeManagementDefinition - -# Interface: SavedObjectsTypeManagementDefinition - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsTypeManagementDefinition - -Configuration options for the [type](client._internal_namespace.SavedObjectsType.md)'s management section. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Attributes` | `any` | - -## Table of contents - -### Properties - -- [defaultSearchField](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#defaultsearchfield) -- [displayName](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#displayname) -- [icon](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#icon) -- [importableAndExportable](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#importableandexportable) -- [isExportable](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#isexportable) -- [onExport](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#onexport) -- [onImport](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#onimport) -- [visibleInManagement](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#visibleinmanagement) - -### Methods - -- [getEditUrl](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#getediturl) -- [getInAppUrl](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#getinappurl) -- [getTitle](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#gettitle) - -## Properties - -### defaultSearchField - -• `Optional` **defaultSearchField**: `string` - -The default search field to use for this type. Defaults to `id`. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:337 - -___ - -### displayName - -• `Optional` **displayName**: `string` - -When specified, will be used instead of the type's name in SO management section's labels. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:324 - -___ - -### icon - -• `Optional` **icon**: `string` - -The eui icon name to display in the management table. -If not defined, the default icon will be used. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:342 - -___ - -### importableAndExportable - -• `Optional` **importableAndExportable**: `boolean` - -Is the type importable or exportable. Defaults to `false`. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:320 - -___ - -### isExportable - -• `Optional` **isExportable**: [`SavedObjectsExportablePredicate`](../modules/client._internal_namespace.md#savedobjectsexportablepredicate)<`Attributes`\> - -Optional hook to specify whether an object should be exportable. - -If specified, `isExportable` will be called during export for each -of this type's objects in the export, and the ones not matching the -predicate will be excluded from the export. - -When implementing both `isExportable` and `onExport`, it is mandatory that -`isExportable` returns the same value for an object before and after going -though the export transform. -E.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)` - -**`example`** -Registering a type with a per-object exportability predicate -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - isExportable: (object) => { - if (object.attributes.myCustomAttr === 'foo') { - return false; - } - return true; - } - }, - }); - } -} -``` - -**`remarks`** `importableAndExportable` must be `true` to specify this property. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:462 - -___ - -### onExport - -• `Optional` **onExport**: [`SavedObjectsExportTransform`](../modules/client._internal_namespace.md#savedobjectsexporttransform)<`Attributes`\> - -An optional export transform function that can be used transform the objects of the registered type during -the export process. - -It can be used to either mutate the exported objects, or add additional objects (of any type) to the export list. - -See [the transform type documentation](../modules/client._internal_namespace.md#savedobjectsexporttransform) for more info and examples. - -When implementing both `isExportable` and `onExport`, it is mandatory that -`isExportable` returns the same value for an object before and after going -though the export transform. -E.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)` - -**`remarks`** `importableAndExportable` must be `true` to specify this property. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:380 - -___ - -### onImport - -• `Optional` **onImport**: [`SavedObjectsImportHook`](../modules/client._internal_namespace.md#savedobjectsimporthook)<`Attributes`\> - -An optional [import hook](../modules/client._internal_namespace.md#savedobjectsimporthook) to use when importing given type. - -Import hooks are executed during the savedObjects import process and allow to interact -with the imported objects. See the [hook documentation](../modules/client._internal_namespace.md#savedobjectsimporthook) -for more info. - -**`example`** -Registering a hook displaying a warning about a specific type of object -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onImport: (objects) => { - if(someActionIsNeeded(objects)) { - return { - warnings: [ - { - type: 'action_required', - message: 'Objects need to be manually enabled after import', - actionPath: '/app/my-app/require-activation', - }, - ] - } - } - return {}; - } - }, - }); - } -} -``` - -**`remarks`** messages returned in the warnings are user facing and must be translated. - -**`remarks`** `importableAndExportable` must be `true` to specify this property. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:423 - -___ - -### visibleInManagement - -• `Optional` **visibleInManagement**: `boolean` - -When set to false, the type will not be listed or searchable in the SO management section. -Main usage of setting this property to false for a type is when objects from the type should -be included in the export via references or export hooks, but should not directly appear in the SOM. -Defaults to `true`. - -**`remarks`** `importableAndExportable` must be `true` to specify this property. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:333 - -## Methods - -### getEditUrl - -▸ `Optional` **getEditUrl**(`savedObject`): `string` - -Function returning the url to use to redirect to the editing page of this object. -If not defined, editing will not be allowed. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `savedObject` | [`SavedObject`](client._internal_namespace.SavedObject.md)<`Attributes`\> | - -#### Returns - -`string` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:352 - -___ - -### getInAppUrl - -▸ `Optional` **getInAppUrl**(`savedObject`): `Object` - -Function returning the url to use to redirect to this object from the management section. -If not defined, redirecting to the object will not be allowed. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `savedObject` | [`SavedObject`](client._internal_namespace.SavedObject.md)<`Attributes`\> | - -#### Returns - -`Object` - -an object containing a `path` and `uiCapabilitiesPath` properties. the `path` is the path to - the object page, relative to the base path. `uiCapabilitiesPath` is the path to check in the - [uiCapabilities](client._internal_namespace.Capabilities.md) to check if the user has permission to access the object. - -| Name | Type | -| :------ | :------ | -| `path` | `string` | -| `uiCapabilitiesPath` | `string` | - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:361 - -___ - -### getTitle - -▸ `Optional` **getTitle**(`savedObject`): `string` - -Function returning the title to display in the management table. -If not defined, will use the object's type and id to generate a label. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `savedObject` | [`SavedObject`](client._internal_namespace.SavedObject.md)<`Attributes`\> | - -#### Returns - -`string` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:347 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md deleted file mode 100644 index 4ebbf456a05564..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md +++ /dev/null @@ -1,62 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsTypeMappingDefinition - -# Interface: SavedObjectsTypeMappingDefinition - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsTypeMappingDefinition - -Describe a saved object type mapping. - -**`example`** -```ts -const typeDefinition: SavedObjectsTypeMappingDefinition = { - properties: { - enabled: { - type: "boolean" - }, - sendUsageFrom: { - ignore_above: 256, - type: "keyword" - }, - lastReported: { - type: "date" - }, - lastVersionChecked: { - ignore_above: 256, - type: "keyword" - }, - } -} -``` - -## Table of contents - -### Properties - -- [dynamic](client._internal_namespace.SavedObjectsTypeMappingDefinition.md#dynamic) -- [properties](client._internal_namespace.SavedObjectsTypeMappingDefinition.md#properties) - -## Properties - -### dynamic - -• `Optional` **dynamic**: ``false`` \| ``"strict"`` - -The dynamic property of the mapping, either `false` or `'strict'`. If -unspecified `dynamic: 'strict'` will be inherited from the top-level -index mappings. - -#### Defined in - -src/core/target/types/server/saved_objects/mappings/types.d.ts:33 - -___ - -### properties - -• **properties**: [`SavedObjectsMappingProperties`](client._internal_namespace.SavedObjectsMappingProperties.md) - -The underlying properties of the type mapping - -#### Defined in - -src/core/target/types/server/saved_objects/mappings/types.d.ts:35 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md deleted file mode 100644 index 5f5243a72ad696..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md +++ /dev/null @@ -1,68 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateObjectsSpacesObject - -# Interface: SavedObjectsUpdateObjectsSpacesObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateObjectsSpacesObject - -An object that should have its spaces updated. - -## Table of contents - -### Properties - -- [id](client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md#id) -- [spaces](client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md#spaces) -- [type](client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md#type) -- [version](client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md#version) - -## Properties - -### id - -• **id**: `string` - -The type of the object to update - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:14 - -___ - -### spaces - -• `Optional` **spaces**: `string`[] - -The space(s) that the object to update currently exists in. This is only intended to be used by SOC wrappers. - -**`internal`** - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:22 - -___ - -### type - -• **type**: `string` - -The ID of the object to update - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:16 - -___ - -### version - -• `Optional` **version**: `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`** - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:28 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md deleted file mode 100644 index 403680115772cf..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md +++ /dev/null @@ -1,48 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateObjectsSpacesOptions - -# Interface: SavedObjectsUpdateObjectsSpacesOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateObjectsSpacesOptions - -Options for the update operation. - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsUpdateObjectsSpacesOptions`** - -## Table of contents - -### Properties - -- [namespace](client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md#namespace) -- [refresh](client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md#refresh) - -## Properties - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### refresh - -• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) - -The Elasticsearch Refresh setting for this operation - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:37 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md deleted file mode 100644 index 204b50f4846571..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md +++ /dev/null @@ -1,23 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateObjectsSpacesResponse - -# Interface: SavedObjectsUpdateObjectsSpacesResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateObjectsSpacesResponse - -The response when objects' spaces are updated. - -## Table of contents - -### Properties - -- [objects](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md#objects) - -## Properties - -### objects - -• **objects**: [`SavedObjectsUpdateObjectsSpacesResponseObject`](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md)[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md deleted file mode 100644 index f529bdcf9344b5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md +++ /dev/null @@ -1,64 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateObjectsSpacesResponseObject - -# Interface: SavedObjectsUpdateObjectsSpacesResponseObject - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateObjectsSpacesResponseObject - -Details about a specific object's update result. - -## Table of contents - -### Properties - -- [error](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md#error) -- [id](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md#id) -- [spaces](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md#spaces) -- [type](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md#type) - -## Properties - -### error - -• `Optional` **error**: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) - -Included if there was an error updating this object's spaces - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:60 - -___ - -### id - -• **id**: `string` - -The ID of the referenced object - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:56 - -___ - -### spaces - -• **spaces**: `string`[] - -The space(s) that the referenced object exists in - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:58 - -___ - -### type - -• **type**: `string` - -The type of the referenced object - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:54 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md deleted file mode 100644 index 0c7500b08b2feb..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md +++ /dev/null @@ -1,91 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateOptions - -# Interface: SavedObjectsUpdateOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateOptions - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Attributes` | `unknown` | - -## Hierarchy - -- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) - - ↳ **`SavedObjectsUpdateOptions`** - -## Table of contents - -### Properties - -- [namespace](client._internal_namespace.SavedObjectsUpdateOptions.md#namespace) -- [references](client._internal_namespace.SavedObjectsUpdateOptions.md#references) -- [refresh](client._internal_namespace.SavedObjectsUpdateOptions.md#refresh) -- [upsert](client._internal_namespace.SavedObjectsUpdateOptions.md#upsert) -- [version](client._internal_namespace.SavedObjectsUpdateOptions.md#version) - -## Properties - -### namespace - -• `Optional` **namespace**: `string` - -Specify the namespace for this operation - -#### Inherited from - -[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:126 - -___ - -### references - -• `Optional` **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -{@inheritdoc SavedObjectReference} - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:191 - -___ - -### refresh - -• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) - -The Elasticsearch Refresh setting for this operation - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:193 - -___ - -### upsert - -• `Optional` **upsert**: `Attributes` - -If specified, will be used to perform an upsert if the document doesn't exist - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:195 - -___ - -### version - -• `Optional` **version**: `string` - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:189 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md deleted file mode 100644 index 2fa6a0e54a5564..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md +++ /dev/null @@ -1,199 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateResponse - -# Interface: SavedObjectsUpdateResponse - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateResponse - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- `Omit`<[`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\>, ``"attributes"`` \| ``"references"``\> - - ↳ **`SavedObjectsUpdateResponse`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.SavedObjectsUpdateResponse.md#attributes) -- [coreMigrationVersion](client._internal_namespace.SavedObjectsUpdateResponse.md#coremigrationversion) -- [error](client._internal_namespace.SavedObjectsUpdateResponse.md#error) -- [id](client._internal_namespace.SavedObjectsUpdateResponse.md#id) -- [migrationVersion](client._internal_namespace.SavedObjectsUpdateResponse.md#migrationversion) -- [namespaces](client._internal_namespace.SavedObjectsUpdateResponse.md#namespaces) -- [originId](client._internal_namespace.SavedObjectsUpdateResponse.md#originid) -- [references](client._internal_namespace.SavedObjectsUpdateResponse.md#references) -- [type](client._internal_namespace.SavedObjectsUpdateResponse.md#type) -- [updated\_at](client._internal_namespace.SavedObjectsUpdateResponse.md#updated_at) -- [version](client._internal_namespace.SavedObjectsUpdateResponse.md#version) - -## Properties - -### attributes - -• **attributes**: `Partial`<`T`\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:271 - -___ - -### coreMigrationVersion - -• `Optional` **coreMigrationVersion**: `string` - -A semver value that is used when upgrading objects between Kibana versions. - -#### Inherited from - -Omit.coreMigrationVersion - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:67 - -___ - -### error - -• `Optional` **error**: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) - -#### Inherited from - -Omit.error - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:59 - -___ - -### id - -• **id**: `string` - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -#### Inherited from - -Omit.id - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:52 - -___ - -### migrationVersion - -• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) - -{@inheritdoc SavedObjectsMigrationVersion} - -#### Inherited from - -Omit.migrationVersion - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:65 - -___ - -### namespaces - -• `Optional` **namespaces**: `string`[] - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with -`namespaceType: 'agnostic'`. - -#### Inherited from - -Omit.namespaces - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:72 - -___ - -### originId - -• `Optional` **originId**: `string` - -The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration -from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import -to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given -space. - -#### Inherited from - -Omit.originId - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:79 - -___ - -### references - -• **references**: `undefined` \| [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:272 - -___ - -### type - -• **type**: `string` - -The type of Saved Object. Each plugin can define it's own custom Saved Object types. - -#### Inherited from - -Omit.type - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:54 - -___ - -### updated\_at - -• `Optional` **updated\_at**: `string` - -Timestamp of the last time this document had been updated. - -#### Inherited from - -Omit.updated\_at - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:58 - -___ - -### version - -• `Optional` **version**: `string` - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -#### Inherited from - -Omit.version - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:56 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsValidationMap.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsValidationMap.md deleted file mode 100644 index 366dc9fe0a476d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsValidationMap.md +++ /dev/null @@ -1,34 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsValidationMap - -# Interface: SavedObjectsValidationMap - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsValidationMap - -A map of [validation specs](../modules/client._internal_namespace.md#savedobjectsvalidationspec) to be used for a given type. -The map's keys must be valid semver versions. - -Any time you change the schema of a [SavedObjectsType](client._internal_namespace.SavedObjectsType.md), you should add a new entry -to this map for the Kibana version the change was introduced in. - -**`example`** -```typescript -const validationMap: SavedObjectsValidationMap = { - '1.0.0': schema.object({ - foo: schema.string(), - }), - '2.0.0': schema.object({ - foo: schema.string({ - minLength: 2, - validate(value) { - if (!/^[a-z]+$/.test(value)) { - return 'must be lowercase letters only'; - } - } - }), - }), -} -``` - -## Indexable - -▪ [version: `string`]: [`SavedObjectsValidationSpec`](../modules/client._internal_namespace.md#savedobjectsvalidationspec) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Services.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Services.md deleted file mode 100644 index 3a770aca3f5954..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Services.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Services - -# Interface: Services - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Services - -## Table of contents - -### Properties - -- [connectorTokenClient](client._internal_namespace.Services.md#connectortokenclient) -- [savedObjectsClient](client._internal_namespace.Services.md#savedobjectsclient) -- [scopedClusterClient](client._internal_namespace.Services.md#scopedclusterclient) - -## Properties - -### connectorTokenClient - -• **connectorTokenClient**: [`ConnectorTokenClient`](../classes/client._internal_namespace.ConnectorTokenClient.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:26 - -___ - -### savedObjectsClient - -• **savedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:24 - -___ - -### scopedClusterClient - -• **scopedClusterClient**: [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:25 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Space.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Space.md deleted file mode 100644 index 018efefd6f456e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Space.md +++ /dev/null @@ -1,131 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Space - -# Interface: Space - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Space - -A Space. - -## Hierarchy - -- **`Space`** - - ↳ [`GetSpaceResult`](client._internal_namespace.GetSpaceResult.md) - -## Table of contents - -### Properties - -- [\_reserved](client._internal_namespace.Space.md#_reserved) -- [color](client._internal_namespace.Space.md#color) -- [description](client._internal_namespace.Space.md#description) -- [disabledFeatures](client._internal_namespace.Space.md#disabledfeatures) -- [id](client._internal_namespace.Space.md#id) -- [imageUrl](client._internal_namespace.Space.md#imageurl) -- [initials](client._internal_namespace.Space.md#initials) -- [name](client._internal_namespace.Space.md#name) - -## Properties - -### \_reserved - -• `Optional` `Private` **\_reserved**: `boolean` - -Indicates that this space is reserved (system controlled). -Reserved spaces cannot be created or deleted by end-users. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:46 - -___ - -### color - -• `Optional` **color**: `string` - -Optional color (hex code) for this space. -If neither `color` nor `imageUrl` is specified, then a color will be automatically generated. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:24 - -___ - -### description - -• `Optional` **description**: `string` - -Optional description for this space. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:19 - -___ - -### disabledFeatures - -• **disabledFeatures**: `string`[] - -The set of feature ids that should be hidden within this space. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:40 - -___ - -### id - -• **id**: `string` - -The unique identifier for this space. -The id becomes part of the "URL Identifier" of the space. - -Example: an id of `marketing` would result in the URL identifier of `/s/marketing`. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:11 - -___ - -### imageUrl - -• `Optional` **imageUrl**: `string` - -Optional base-64 encoded data image url to show as this space's avatar. -This setting takes precedence over any configured `color` or `initials`. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:36 - -___ - -### initials - -• `Optional` **initials**: `string` - -Optional display initials for this space's avatar. Supports a maximum of 2 characters. -If initials are not provided, then they will be derived from the space name automatically. - -Initials are not displayed if an `imageUrl` has been specified. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:31 - -___ - -### name - -• **name**: `string` - -Display name for this space. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:15 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SpacesServiceStart.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SpacesServiceStart.md deleted file mode 100644 index 5dd67943c579f2..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SpacesServiceStart.md +++ /dev/null @@ -1,150 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SpacesServiceStart - -# Interface: SpacesServiceStart - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SpacesServiceStart - -The Spaces service start contract. - -## Table of contents - -### Methods - -- [createSpacesClient](client._internal_namespace.SpacesServiceStart.md#createspacesclient) -- [getActiveSpace](client._internal_namespace.SpacesServiceStart.md#getactivespace) -- [getSpaceId](client._internal_namespace.SpacesServiceStart.md#getspaceid) -- [isInDefaultSpace](client._internal_namespace.SpacesServiceStart.md#isindefaultspace) -- [namespaceToSpaceId](client._internal_namespace.SpacesServiceStart.md#namespacetospaceid) -- [spaceIdToNamespace](client._internal_namespace.SpacesServiceStart.md#spaceidtonamespace) - -## Methods - -### createSpacesClient - -▸ **createSpacesClient**(`request`): [`ISpacesClient`](client._internal_namespace.ISpacesClient.md) - -Creates a scoped instance of the SpacesClient. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | the request. | - -#### Returns - -[`ISpacesClient`](client._internal_namespace.ISpacesClient.md) - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:32 - -___ - -### getActiveSpace - -▸ **getActiveSpace**(`request`): `Promise`<[`Space`](client._internal_namespace.Space.md)\> - -Retrieves the Space associated with the provided request. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | the request. | - -#### Returns - -`Promise`<[`Space`](client._internal_namespace.Space.md)\> - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:47 - -___ - -### getSpaceId - -▸ **getSpaceId**(`request`): `string` - -Retrieves the space id associated with the provided request. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | the request. | - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:37 - -___ - -### isInDefaultSpace - -▸ **isInDefaultSpace**(`request`): `boolean` - -Indicates if the provided request is executing within the context of the `default` space. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | the request. | - -#### Returns - -`boolean` - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:42 - -___ - -### namespaceToSpaceId - -▸ **namespaceToSpaceId**(`namespace`): `string` - -Converts the provided namespace into the corresponding space id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `namespace` | `undefined` \| `string` | the namespace to convert. | - -#### Returns - -`string` - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:57 - -___ - -### spaceIdToNamespace - -▸ **spaceIdToNamespace**(`spaceId`): `undefined` \| `string` - -Converts the provided space id into the corresponding Saved Objects `namespace` id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `spaceId` | `string` | the space id to convert. | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:52 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeatureConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeatureConfig.md deleted file mode 100644 index adfb11e4efd7d1..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeatureConfig.md +++ /dev/null @@ -1,38 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SubFeatureConfig - -# Interface: SubFeatureConfig - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SubFeatureConfig - -Configuration for a sub-feature. - -## Table of contents - -### Properties - -- [name](client._internal_namespace.SubFeatureConfig.md#name) -- [privilegeGroups](client._internal_namespace.SubFeatureConfig.md#privilegegroups) - -## Properties - -### name - -• **name**: `string` - -Display name for this sub-feature - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:9 - -___ - -### privilegeGroups - -• **privilegeGroups**: readonly [`SubFeaturePrivilegeGroupConfig`](client._internal_namespace.SubFeaturePrivilegeGroupConfig.md)[] - -Collection of privilege groups - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:11 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md deleted file mode 100644 index 4cbd7bc89efc74..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md +++ /dev/null @@ -1,334 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SubFeaturePrivilegeConfig - -# Interface: SubFeaturePrivilegeConfig - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SubFeaturePrivilegeConfig - -Configuration for a sub-feature privilege. - -## Hierarchy - -- `Omit`<[`FeatureKibanaPrivileges`](client._internal_namespace.FeatureKibanaPrivileges.md), ``"excludeFromBasePrivileges"``\> - - ↳ **`SubFeaturePrivilegeConfig`** - -## Table of contents - -### Properties - -- [alerting](client._internal_namespace.SubFeaturePrivilegeConfig.md#alerting) -- [api](client._internal_namespace.SubFeaturePrivilegeConfig.md#api) -- [app](client._internal_namespace.SubFeaturePrivilegeConfig.md#app) -- [cases](client._internal_namespace.SubFeaturePrivilegeConfig.md#cases) -- [catalogue](client._internal_namespace.SubFeaturePrivilegeConfig.md#catalogue) -- [disabled](client._internal_namespace.SubFeaturePrivilegeConfig.md#disabled) -- [id](client._internal_namespace.SubFeaturePrivilegeConfig.md#id) -- [includeIn](client._internal_namespace.SubFeaturePrivilegeConfig.md#includein) -- [management](client._internal_namespace.SubFeaturePrivilegeConfig.md#management) -- [minimumLicense](client._internal_namespace.SubFeaturePrivilegeConfig.md#minimumlicense) -- [name](client._internal_namespace.SubFeaturePrivilegeConfig.md#name) -- [requireAllSpaces](client._internal_namespace.SubFeaturePrivilegeConfig.md#requireallspaces) -- [savedObject](client._internal_namespace.SubFeaturePrivilegeConfig.md#savedobject) -- [ui](client._internal_namespace.SubFeaturePrivilegeConfig.md#ui) - -## Properties - -### alerting - -• `Optional` **alerting**: `Object` - -If your feature requires access to specific Alert Types, then specify your access needs here. -Include both Alert Types registered by the feature and external Alert Types such as built-in -Alert Types and Alert Types provided by other features to which you wish to grant access. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `alert?` | `Object` | -| `alert.all?` | readonly `string`[] | -| `alert.read?` | readonly `string`[] | -| `rule?` | `Object` | -| `rule.all?` | readonly `string`[] | -| `rule.read?` | readonly `string`[] | - -#### Inherited from - -Omit.alerting - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:82 - -___ - -### api - -• `Optional` **api**: readonly `string`[] - -If your feature includes server-side APIs, you can tag those routes to secure access based on user permissions. - -**`example`** -```ts - // Configure your routes with a tag starting with the 'access:' prefix - server.route({ - path: '/api/my-route', - method: 'GET', - handler: () => { ...}, - options: { - tags: ['access:my_feature-admin'] - } - }); - - Then, specify the tags here (without the 'access:' prefix) which should be secured: - - { - api: ['my_feature-admin'] - } -``` - -NOTE: It is important to name your tags in a way that will not collide with other plugins/features. -A generic tag name like "access:read" could be used elsewhere, and access to that API endpoint would also -extend to any routes you have also tagged with that name. - -#### Inherited from - -Omit.api - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:64 - -___ - -### app - -• `Optional` **app**: readonly `string`[] - -If your feature exposes a client-side application (most of them do!), then you can control access to them here. - -**`example`** -```ts - { - app: ['my-app', 'kibana'] - } -``` - -#### Inherited from - -Omit.app - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:76 - -___ - -### cases - -• `Optional` **cases**: `Object` - -If your feature requires access to specific owners of cases (aka plugins that have created cases), then specify your access needs here. The values here should -be unique identifiers for the owners of cases you want access to. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `all?` | readonly `string`[] | List of case owners which users should have full read/write access to when granted this privilege. **`example`** ```ts { all: ['securitySolution'] } ``` | -| `read?` | readonly `string`[] | List of case owners which users should have read-only access to when granted this privilege. **`example`** ```ts { read: ['securitySolution'] } ``` | - -#### Inherited from - -Omit.cases - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:132 - -___ - -### catalogue - -• `Optional` **catalogue**: readonly `string`[] - -If this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions. - -#### Inherited from - -Omit.catalogue - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:37 - -___ - -### disabled - -• `Optional` **disabled**: `boolean` - -Whether or not this privilege should be hidden in the roles UI and disallowed on the API. Defaults to `false`. - -**`deprecated`** - -#### Inherited from - -Omit.disabled - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:18 - -___ - -### id - -• **id**: `string` - -Identifier for this privilege. Must be unique across all other privileges within a feature. - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:47 - -___ - -### includeIn - -• **includeIn**: ``"all"`` \| ``"none"`` \| ``"read"`` - -Denotes which Primary Feature Privilege this sub-feature privilege should be included in. -`read` is also included in `all` automatically. - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:56 - -___ - -### management - -• `Optional` **management**: `Object` - -If this feature includes management sections, you can specify them here to control visibility of those -pages based on user privileges. - -**`example`** -```ts - // Enables access to the "Advanced Settings" management page within the Kibana section - management: { - kibana: ['settings'] - } -``` - -#### Index signature - -▪ [sectionId: `string`]: readonly `string`[] - -#### Inherited from - -Omit.management - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:31 - -___ - -### minimumLicense - -• `Optional` **minimumLicense**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` - -The minimum supported license level for this sub-feature privilege. -If no license level is supplied, then this privilege will be available for all licences -that are valid for the overall feature. - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:62 - -___ - -### name - -• **name**: `string` - -The display name for this privilege. - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:51 - -___ - -### requireAllSpaces - -• `Optional` **requireAllSpaces**: `boolean` - -Whether or not this privilege should only be granted to `All Spaces *`. Should be used for features that do not -support Spaces. Defaults to `false`. - -#### Inherited from - -Omit.requireAllSpaces - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:13 - -___ - -### savedObject - -• **savedObject**: `Object` - -If your feature requires access to specific saved objects, then specify your access needs here. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `all` | readonly `string`[] | List of saved object types which users should have full read/write access to when granted this privilege. **`example`** ```ts { all: ['my-saved-object-type'] } ``` | -| `read` | readonly `string`[] | List of saved object types which users should have read-only access to when granted this privilege. **`example`** ```ts { read: ['config'] } ``` | - -#### Inherited from - -Omit.savedObject - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:157 - -___ - -### ui - -• **ui**: readonly `string`[] - -A list of UI Capabilities that should be granted to users with this privilege. -These capabilities will automatically be namespaces within your feature id. - -**`example`** -```ts - { - ui: ['show', 'save'] - } - - This translates in the UI to the following (assuming a feature id of "foo"): - import { uiCapabilities } from 'ui/capabilities'; - - const canShowApp = uiCapabilities.foo.show; - const canSave = uiCapabilities.foo.save; -``` -Note: Since these are automatically namespaced, you are free to use generic names like "show" and "save". - -**`see`** UICapabilities - -#### Inherited from - -Omit.ui - -#### Defined in - -x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:199 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md deleted file mode 100644 index 28dcebc6af10ca..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SubFeaturePrivilegeGroupConfig - -# Interface: SubFeaturePrivilegeGroupConfig - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SubFeaturePrivilegeGroupConfig - -Configuration for a sub-feature privilege group. - -## Table of contents - -### Properties - -- [groupType](client._internal_namespace.SubFeaturePrivilegeGroupConfig.md#grouptype) -- [privileges](client._internal_namespace.SubFeaturePrivilegeGroupConfig.md#privileges) - -## Properties - -### groupType - -• **groupType**: [`SubFeaturePrivilegeGroupType`](../modules/client._internal_namespace.md#subfeatureprivilegegrouptype) - -The type of privilege group. -- `mutually_exclusive`:: - Users will be able to select at most one privilege within this group. - Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All) -- `independent`:: - Users will be able to select any combination of privileges within this group. - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:34 - -___ - -### privileges - -• **privileges**: readonly [`SubFeaturePrivilegeConfig`](client._internal_namespace.SubFeaturePrivilegeConfig.md)[] - -The privileges which belong to this group. - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:38 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInfo.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInfo.md deleted file mode 100644 index 56843b1283c192..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskInfo - -# Interface: TaskInfo - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskInfo - -## Table of contents - -### Properties - -- [attempts](client._internal_namespace.TaskInfo.md#attempts) -- [scheduled](client._internal_namespace.TaskInfo.md#scheduled) - -## Properties - -### attempts - -• **attempts**: `number` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:22 - -___ - -### scheduled - -• **scheduled**: `Date` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:21 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInstance.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInstance.md deleted file mode 100644 index 4cea61eafbdb24..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInstance.md +++ /dev/null @@ -1,199 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskInstance - -# Interface: TaskInstance - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskInstance - -## Hierarchy - -- **`TaskInstance`** - - ↳ [`ConcreteTaskInstance`](client._internal_namespace.ConcreteTaskInstance.md) - -## Table of contents - -### Properties - -- [id](client._internal_namespace.TaskInstance.md#id) -- [ownerId](client._internal_namespace.TaskInstance.md#ownerid) -- [params](client._internal_namespace.TaskInstance.md#params) -- [retryAt](client._internal_namespace.TaskInstance.md#retryat) -- [runAt](client._internal_namespace.TaskInstance.md#runat) -- [schedule](client._internal_namespace.TaskInstance.md#schedule) -- [scheduledAt](client._internal_namespace.TaskInstance.md#scheduledat) -- [scope](client._internal_namespace.TaskInstance.md#scope) -- [startedAt](client._internal_namespace.TaskInstance.md#startedat) -- [state](client._internal_namespace.TaskInstance.md#state) -- [taskType](client._internal_namespace.TaskInstance.md#tasktype) -- [traceparent](client._internal_namespace.TaskInstance.md#traceparent) -- [user](client._internal_namespace.TaskInstance.md#user) - -## Properties - -### id - -• `Optional` **id**: `string` - -Optional ID that can be passed by the caller. When ID is undefined, ES -will auto-generate a unique id. Otherwise, ID will be used to either -create a new document, or update existing document - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:145 - -___ - -### ownerId - -• `Optional` **ownerId**: ``null`` \| `string` - -The random uuid of the Kibana instance which claimed ownership of the task last - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:205 - -___ - -### params - -• **params**: `Record`<`string`, `any`\> - -A task-specific set of parameters, used by the task's run function to tailor -its work. This is generally user-input, such as { sms: '333-444-2222' }. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:182 - -___ - -### retryAt - -• `Optional` **retryAt**: ``null`` \| `Date` - -The date and time that this task should re-execute if stuck in "running" / timeout -status. This value is only set when status is set to "running". - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:165 - -___ - -### runAt - -• `Optional` **runAt**: `Date` - -The date and time that this task is scheduled to be run. It is not -guaranteed to run at this time, but it is guaranteed not to run earlier -than this. Defaults to immediately. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:171 - -___ - -### schedule - -• `Optional` **schedule**: [`IntervalSchedule`](client._internal_namespace.IntervalSchedule.md) - -A TaskSchedule string, which specifies this as a recurring task. - -Currently, this supports a single format: an interval in minutes or seconds (e.g. '5m', '30s'). - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:177 - -___ - -### scheduledAt - -• `Optional` **scheduledAt**: `Date` - -The date and time that this task was originally scheduled. This is used -for convenience to task run functions, and for troubleshooting. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:154 - -___ - -### scope - -• `Optional` **scope**: `string`[] - -Used to group tasks for querying. So, reporting might schedule tasks with a scope of 'reporting', -and then query such tasks to provide a glimpse at only reporting tasks, rather than at all tasks. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:201 - -___ - -### startedAt - -• `Optional` **startedAt**: ``null`` \| `Date` - -The date and time that this task started execution. This is used to determine -the "real" runAt that ended up running the task. This value is only set -when status is set to "running". - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:160 - -___ - -### state - -• **state**: `Record`<`string`, `any`\> - -The state passed into the task's run function, and returned by the previous -run. If there was no previous run, or if the previous run did not return -any state, this will be the empy object: {} - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:188 - -___ - -### taskType - -• **taskType**: `string` - -The task definition type whose run function will execute this instance. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:149 - -___ - -### traceparent - -• `Optional` **traceparent**: `string` - -The serialized traceparent string of the current APM transaction or span. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:192 - -___ - -### user - -• `Optional` **user**: `string` - -The id of the user who scheduled this task. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:196 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskManagerSetupContract.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskManagerSetupContract.md deleted file mode 100644 index 15c8f2fe2b91e9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskManagerSetupContract.md +++ /dev/null @@ -1,70 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskManagerSetupContract - -# Interface: TaskManagerSetupContract - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskManagerSetupContract - -## Table of contents - -### Properties - -- [index](client._internal_namespace.TaskManagerSetupContract.md#index) - -### Methods - -- [addMiddleware](client._internal_namespace.TaskManagerSetupContract.md#addmiddleware) -- [registerTaskDefinitions](client._internal_namespace.TaskManagerSetupContract.md#registertaskdefinitions) - -## Properties - -### index - -• **index**: `string` - -**`deprecated`** - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/plugin.d.ts:12 - -## Methods - -### addMiddleware - -▸ **addMiddleware**(`middleware`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `middleware` | [`Middleware`](client._internal_namespace.Middleware.md) | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/plugin.d.ts:13 - -___ - -### registerTaskDefinitions - -▸ **registerTaskDefinitions**(`taskDefinitions`): `void` - -Method for allowing consumers to register task definitions into the system. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `taskDefinitions` | [`TaskDefinitionRegistry`](../modules/client._internal_namespace.md#taskdefinitionregistry) | The Kibana task definitions dictionary | - -#### Returns - -`void` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/plugin.d.ts:18 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRegisterDefinition.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRegisterDefinition.md deleted file mode 100644 index f5d534feba6007..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRegisterDefinition.md +++ /dev/null @@ -1,130 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskRegisterDefinition - -# Interface: TaskRegisterDefinition - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskRegisterDefinition - -Defines a task which can be scheduled and run by the Kibana -task manager. - -## Table of contents - -### Properties - -- [createTaskRunner](client._internal_namespace.TaskRegisterDefinition.md#createtaskrunner) -- [description](client._internal_namespace.TaskRegisterDefinition.md#description) -- [maxAttempts](client._internal_namespace.TaskRegisterDefinition.md#maxattempts) -- [maxConcurrency](client._internal_namespace.TaskRegisterDefinition.md#maxconcurrency) -- [timeout](client._internal_namespace.TaskRegisterDefinition.md#timeout) -- [title](client._internal_namespace.TaskRegisterDefinition.md#title) - -### Methods - -- [getRetry](client._internal_namespace.TaskRegisterDefinition.md#getretry) - -## Properties - -### createTaskRunner - -• **createTaskRunner**: [`TaskRunCreatorFunction`](../modules/client._internal_namespace.md#taskruncreatorfunction) - -Creates an object that has a run function which performs the task's work, -and an optional cancel function which cancels the task. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:35 - -___ - -### description - -• `Optional` **description**: `string` - -An optional more detailed description of what this task does. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:22 - -___ - -### maxAttempts - -• `Optional` **maxAttempts**: `number` - -Up to how many times the task should retry when it fails to run. This will -default to the global variable. The default value, if not specified, is 1. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:40 - -___ - -### maxConcurrency - -• `Optional` **maxConcurrency**: `number` - -The maximum number tasks of this type that can be run concurrently per Kibana instance. -Setting this value will force Task Manager to poll for this task type separately from other task types -which can add significant load to the ES cluster, so please use this configuration only when absolutely necessary. -The default value, if not given, is 0. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:47 - -___ - -### timeout - -• `Optional` **timeout**: `string` - -How long, in minutes or seconds, the system should wait for the task to complete -before it is considered to be timed out. (e.g. '5m', the default). If -the task takes longer than this, Kibana will send it a kill command and -the task will be re-attempted. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:18 - -___ - -### title - -• `Optional` **title**: `string` - -A brief, human-friendly title for this task. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:11 - -## Methods - -### getRetry - -▸ `Optional` **getRetry**(`attempts`, `error`): `boolean` \| `Date` - -Function that customizes how the task should behave when the task fails. This -function can return `true`, `false` or a Date. True will tell task manager -to retry using default delay logic. False will tell task manager to stop retrying -this task. Date will suggest when to the task manager the task should retry. -This function isn't used for recurring tasks, those retry as per their configured recurring schedule. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attempts` | `number` | -| `error` | `object` | - -#### Returns - -`boolean` \| `Date` - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:30 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRunnerContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRunnerContext.md deleted file mode 100644 index d79cef9c996c16..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRunnerContext.md +++ /dev/null @@ -1,89 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskRunnerContext - -# Interface: TaskRunnerContext - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskRunnerContext - -## Table of contents - -### Properties - -- [actionTypeRegistry](client._internal_namespace.TaskRunnerContext.md#actiontyperegistry) -- [basePathService](client._internal_namespace.TaskRunnerContext.md#basepathservice) -- [encryptedSavedObjectsClient](client._internal_namespace.TaskRunnerContext.md#encryptedsavedobjectsclient) -- [logger](client._internal_namespace.TaskRunnerContext.md#logger) -- [spaceIdToNamespace](client._internal_namespace.TaskRunnerContext.md#spaceidtonamespace) - -### Methods - -- [getUnsecuredSavedObjectsClient](client._internal_namespace.TaskRunnerContext.md#getunsecuredsavedobjectsclient) - -## Properties - -### actionTypeRegistry - -• **actionTypeRegistry**: [`ActionTypeRegistryContract`](../modules/client._internal_namespace.md#actiontyperegistrycontract) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:8 - -___ - -### basePathService - -• **basePathService**: [`IBasePath`](../modules/client._internal_namespace.md#ibasepath) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:11 - -___ - -### encryptedSavedObjectsClient - -• **encryptedSavedObjectsClient**: [`EncryptedSavedObjectsClient`](client._internal_namespace.EncryptedSavedObjectsClient.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:9 - -___ - -### logger - -• **logger**: `Logger` - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:7 - -___ - -### spaceIdToNamespace - -• **spaceIdToNamespace**: [`SpaceIdToNamespaceFunction`](../modules/client._internal_namespace.md#spaceidtonamespacefunction) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:10 - -## Methods - -### getUnsecuredSavedObjectsClient - -▸ **getUnsecuredSavedObjectsClient**(`request`): [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | - -#### Returns - -[`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:12 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md deleted file mode 100644 index 0a44beb8592e7d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TranslatedUpdateAlertRequest - -# Interface: TranslatedUpdateAlertRequest - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TranslatedUpdateAlertRequest - -## Table of contents - -### Properties - -- [id](client._internal_namespace.TranslatedUpdateAlertRequest.md#id) -- [index](client._internal_namespace.TranslatedUpdateAlertRequest.md#index) -- [status](client._internal_namespace.TranslatedUpdateAlertRequest.md#status) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:208](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L208) - -___ - -### index - -• **index**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:209](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L209) - -___ - -### status - -• **status**: `STATUS_VALUES` - -#### Defined in - -[x-pack/plugins/cases/server/services/alerts/index.ts:210](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L210) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateAlertRequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateAlertRequest.md deleted file mode 100644 index 53ee404bbf12a5..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateAlertRequest.md +++ /dev/null @@ -1,45 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateAlertRequest - -# Interface: UpdateAlertRequest - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateAlertRequest - -Defines the fields necessary to update an alert's status. - -## Table of contents - -### Properties - -- [id](client._internal_namespace.UpdateAlertRequest.md#id) -- [index](client._internal_namespace.UpdateAlertRequest.md#index) -- [status](client._internal_namespace.UpdateAlertRequest.md#status) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/client/alerts/types.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/alerts/types.ts#L28) - -___ - -### index - -• **index**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/client/alerts/types.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/alerts/types.ts#L29) - -___ - -### status - -• **status**: [`CaseStatuses`](../enums/client._internal_namespace.CaseStatuses.md) - -#### Defined in - -[x-pack/plugins/cases/server/client/alerts/types.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/alerts/types.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateArgs.md deleted file mode 100644 index c0f6cf3d0d1a2d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateArgs.md +++ /dev/null @@ -1,43 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateArgs - -# Interface: UpdateArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateArgs - -## Table of contents - -### Properties - -- [attachmentId](client._internal_namespace.UpdateArgs.md#attachmentid) -- [options](client._internal_namespace.UpdateArgs.md#options) -- [updatedAttributes](client._internal_namespace.UpdateArgs.md#updatedattributes) - -## Properties - -### attachmentId - -• **attachmentId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:54](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L54) - -___ - -### options - -• `Optional` **options**: [`SavedObjectsUpdateOptions`](client._internal_namespace.SavedObjectsUpdateOptions.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\> - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:56](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L56) - -___ - -### updatedAttributes - -• **updatedAttributes**: { `created_at`: `undefined` \| `string` = rt.string; `created_by`: `undefined` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } = UserRT; `owner`: `undefined` \| `string` = rt.string; `pushed_at`: `undefined` \| ``null`` \| `string` ; `pushed_by`: `undefined` \| ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } ; `updated_at`: `undefined` \| ``null`` \| `string` ; `updated_by`: `undefined` \| ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } } & { `alertId`: `undefined` \| `string` \| `string`[] ; `index`: `undefined` \| `string` \| `string`[] ; `owner`: `undefined` \| `string` = rt.string; `rule`: `undefined` \| { `id`: ``null`` \| `string` ; `name`: ``null`` \| `string` } ; `type`: `undefined` \| [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `undefined` \| `string` = rt.string; `created_by`: `undefined` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } = UserRT; `owner`: `undefined` \| `string` = rt.string; `pushed_at`: `undefined` \| ``null`` \| `string` ; `pushed_by`: `undefined` \| ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } ; `updated_at`: `undefined` \| ``null`` \| `string` ; `updated_by`: `undefined` \| ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } } - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:55](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L55) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md deleted file mode 100644 index 4af6344e575d6e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md +++ /dev/null @@ -1,64 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateConnectorMappingsArgs - -# Interface: UpdateConnectorMappingsArgs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateConnectorMappingsArgs - -## Hierarchy - -- [`ClientArgs`](client._internal_namespace.ClientArgs-2.md) - - ↳ **`UpdateConnectorMappingsArgs`** - -## Table of contents - -### Properties - -- [attributes](client._internal_namespace.UpdateConnectorMappingsArgs.md#attributes) -- [mappingId](client._internal_namespace.UpdateConnectorMappingsArgs.md#mappingid) -- [references](client._internal_namespace.UpdateConnectorMappingsArgs.md#references) -- [unsecuredSavedObjectsClient](client._internal_namespace.UpdateConnectorMappingsArgs.md#unsecuredsavedobjectsclient) - -## Properties - -### attributes - -• **attributes**: `Partial`<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\> - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L28) - -___ - -### mappingId - -• **mappingId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:27](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L27) - -___ - -### references - -• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L29) - -___ - -### unsecuredSavedObjectsClient - -• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) - -#### Inherited from - -[ClientArgs](client._internal_namespace.ClientArgs-2.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-2.md#unsecuredsavedobjectsclient) - -#### Defined in - -[x-pack/plugins/cases/server/services/connector_mappings/index.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions-1.md deleted file mode 100644 index cd8125ed13bf5a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions-1.md +++ /dev/null @@ -1,54 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateOptions - -# Interface: UpdateOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateOptions - -## Table of contents - -### Properties - -- [expiresAtMillis](client._internal_namespace.UpdateOptions-1.md#expiresatmillis) -- [id](client._internal_namespace.UpdateOptions-1.md#id) -- [token](client._internal_namespace.UpdateOptions-1.md#token) -- [tokenType](client._internal_namespace.UpdateOptions-1.md#tokentype) - -## Properties - -### expiresAtMillis - -• **expiresAtMillis**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:19 - -___ - -### id - -• **id**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:17 - -___ - -### token - -• **token**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:18 - -___ - -### tokenType - -• `Optional` **tokenType**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:20 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions.md deleted file mode 100644 index f1bc3745221754..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateOptions - -# Interface: UpdateOptions - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateOptions - -## Table of contents - -### Properties - -- [action](client._internal_namespace.UpdateOptions.md#action) -- [id](client._internal_namespace.UpdateOptions.md#id) - -## Properties - -### action - -• **action**: [`ActionUpdate`](client._internal_namespace.ActionUpdate.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Defined in - -x-pack/plugins/actions/target/types/server/actions_client.d.ts:40 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.User.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.User.md deleted file mode 100644 index 947805536297fb..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.User.md +++ /dev/null @@ -1,90 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / User - -# Interface: User - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).User - -## Hierarchy - -- **`User`** - - ↳ [`AuthenticatedUser`](client._internal_namespace.AuthenticatedUser.md) - -## Table of contents - -### Properties - -- [email](client._internal_namespace.User.md#email) -- [enabled](client._internal_namespace.User.md#enabled) -- [full\_name](client._internal_namespace.User.md#full_name) -- [metadata](client._internal_namespace.User.md#metadata) -- [roles](client._internal_namespace.User.md#roles) -- [username](client._internal_namespace.User.md#username) - -## Properties - -### email - -• `Optional` **email**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:3 - -___ - -### enabled - -• **enabled**: `boolean` - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:6 - -___ - -### full\_name - -• `Optional` **full\_name**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:4 - -___ - -### metadata - -• `Optional` **metadata**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_deprecated?` | `boolean` | -| `_deprecated_reason?` | `string` | -| `_reserved` | `boolean` | - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:7 - -___ - -### roles - -• **roles**: readonly `string`[] - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:5 - -___ - -### username - -• **username**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/common/model/user.d.ts:2 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UserRealm.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UserRealm.md deleted file mode 100644 index 2d1d75692a0e0a..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UserRealm.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UserRealm - -# Interface: UserRealm - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UserRealm - -## Table of contents - -### Properties - -- [name](client._internal_namespace.UserRealm.md#name) -- [type](client._internal_namespace.UserRealm.md#type) - -## Properties - -### name - -• **name**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ValidatorType.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ValidatorType.md deleted file mode 100644 index c771a20cde1159..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ValidatorType.md +++ /dev/null @@ -1,37 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ValidatorType - -# Interface: ValidatorType - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ValidatorType - -## Type parameters - -| Name | -| :------ | -| `Type` | - -## Table of contents - -### Methods - -- [validate](client._internal_namespace.ValidatorType.md#validate) - -## Methods - -### validate - -▸ **validate**(`value`): `Type` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `unknown` | - -#### Returns - -`Type` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:64 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Verbs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Verbs.md deleted file mode 100644 index 6234a71241e993..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Verbs.md +++ /dev/null @@ -1,45 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Verbs - -# Interface: Verbs - -[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Verbs - -The tenses for describing the action performed by a API route - -## Table of contents - -### Properties - -- [past](client._internal_namespace.Verbs.md#past) -- [present](client._internal_namespace.Verbs.md#present) -- [progressive](client._internal_namespace.Verbs.md#progressive) - -## Properties - -### past - -• **past**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:18](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L18) - -___ - -### present - -• **present**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:16](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L16) - -___ - -### progressive - -• **progressive**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:17](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L17) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.CreateMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.CreateMappingsArgs.md deleted file mode 100644 index 14e3f0fc934591..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.CreateMappingsArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [configure/client](../modules/configure_client.md) / [\_internal\_namespace](../modules/configure_client._internal_namespace.md) / CreateMappingsArgs - -# Interface: CreateMappingsArgs - -[configure/client](../modules/configure_client.md).[_internal_namespace](../modules/configure_client._internal_namespace.md).CreateMappingsArgs - -## Hierarchy - -- [`MappingsArgs`](configure_client._internal_namespace.MappingsArgs.md) - - ↳ **`CreateMappingsArgs`** - -## Table of contents - -### Properties - -- [connector](configure_client._internal_namespace.CreateMappingsArgs.md#connector) -- [owner](configure_client._internal_namespace.CreateMappingsArgs.md#owner) - -## Properties - -### connector - -• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } - -#### Inherited from - -[MappingsArgs](configure_client._internal_namespace.MappingsArgs.md).[connector](configure_client._internal_namespace.MappingsArgs.md#connector) - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/types.ts:11](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L11) - -___ - -### owner - -• **owner**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/types.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.MappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.MappingsArgs.md deleted file mode 100644 index b21de0e3f90189..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.MappingsArgs.md +++ /dev/null @@ -1,29 +0,0 @@ -[Cases Client API Interface](../README.md) / [configure/client](../modules/configure_client.md) / [\_internal\_namespace](../modules/configure_client._internal_namespace.md) / MappingsArgs - -# Interface: MappingsArgs - -[configure/client](../modules/configure_client.md).[_internal_namespace](../modules/configure_client._internal_namespace.md).MappingsArgs - -## Hierarchy - -- **`MappingsArgs`** - - ↳ [`CreateMappingsArgs`](configure_client._internal_namespace.CreateMappingsArgs.md) - - ↳ [`UpdateMappingsArgs`](configure_client._internal_namespace.UpdateMappingsArgs.md) - -## Table of contents - -### Properties - -- [connector](configure_client._internal_namespace.MappingsArgs.md#connector) - -## Properties - -### connector - -• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/types.ts:11](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L11) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md deleted file mode 100644 index e81c67f5bd4a01..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md +++ /dev/null @@ -1,42 +0,0 @@ -[Cases Client API Interface](../README.md) / [configure/client](../modules/configure_client.md) / [\_internal\_namespace](../modules/configure_client._internal_namespace.md) / UpdateMappingsArgs - -# Interface: UpdateMappingsArgs - -[configure/client](../modules/configure_client.md).[_internal_namespace](../modules/configure_client._internal_namespace.md).UpdateMappingsArgs - -## Hierarchy - -- [`MappingsArgs`](configure_client._internal_namespace.MappingsArgs.md) - - ↳ **`UpdateMappingsArgs`** - -## Table of contents - -### Properties - -- [connector](configure_client._internal_namespace.UpdateMappingsArgs.md#connector) -- [mappingId](configure_client._internal_namespace.UpdateMappingsArgs.md#mappingid) - -## Properties - -### connector - -• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } - -#### Inherited from - -[MappingsArgs](configure_client._internal_namespace.MappingsArgs.md).[connector](configure_client._internal_namespace.MappingsArgs.md#connector) - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/types.ts:11](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L11) - -___ - -### mappingId - -• **mappingId**: `string` - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/types.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client.configuresubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client.configuresubclient.md deleted file mode 100644 index 393957ba1c7f50..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client.configuresubclient.md +++ /dev/null @@ -1,100 +0,0 @@ -[Cases Client API Interface](../README.md) / [configure/client](../modules/configure_client.md) / ConfigureSubClient - -# Interface: ConfigureSubClient - -[configure/client](../modules/configure_client.md).ConfigureSubClient - -This is the public API for interacting with the connector configuration for cases. - -## Table of contents - -### Methods - -- [create](configure_client.ConfigureSubClient.md#create) -- [get](configure_client.ConfigureSubClient.md#get) -- [getConnectors](configure_client.ConfigureSubClient.md#getconnectors) -- [update](configure_client.ConfigureSubClient.md#update) - -## Methods - -### create - -▸ **create**(`configuration`): `Promise`<[`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> - -Creates a configuration if one does not already exist. If one exists it is deleted and a new one is created. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration` | [`ICasesConfigureRequest`](typedoc_interfaces.ICasesConfigureRequest.md) | - -#### Returns - -`Promise`<[`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/client.ts:93](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L93) - -___ - -### get - -▸ **get**(`params`): `Promise`<{} \| [`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> - -Retrieves the external connector configuration for a particular case owner. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.owner` | `undefined` \| `string` \| `string`[] | - -#### Returns - -`Promise`<{} \| [`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/client.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L75) - -___ - -### getConnectors - -▸ **getConnectors**(): `Promise`<[`FindActionResult`](client._internal_namespace.FindActionResult.md)[]\> - -Retrieves the valid external connectors supported by the cases plugin. - -#### Returns - -`Promise`<[`FindActionResult`](client._internal_namespace.FindActionResult.md)[]\> - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/client.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L79) - -___ - -### update - -▸ **update**(`configurationId`, `configurations`): `Promise`<[`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> - -Updates a particular configuration with new values. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `configurationId` | `string` | the ID of the configuration to update | -| `configurations` | [`ICasesConfigurePatch`](typedoc_interfaces.ICasesConfigurePatch.md) | the new configuration parameters | - -#### Returns - -`Promise`<[`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/client.ts:86](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L86) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client.MetricsSubClient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client.MetricsSubClient.md deleted file mode 100644 index c59b437c7f23ec..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client.MetricsSubClient.md +++ /dev/null @@ -1,33 +0,0 @@ -[Cases Client API Interface](../README.md) / [metrics/client](../modules/metrics_client.md) / MetricsSubClient - -# Interface: MetricsSubClient - -[metrics/client](../modules/metrics_client.md).MetricsSubClient - -API for interacting with the metrics. - -## Table of contents - -### Methods - -- [getCaseMetrics](metrics_client.MetricsSubClient.md#getcasemetrics) - -## Methods - -### getCaseMetrics - -▸ **getCaseMetrics**(`params`): `Promise`<{ `actions`: `undefined` \| { isolateHost?: { isolate: { total: number; }; unisolate: { total: number; }; } \| undefined; } ; `alerts`: `undefined` \| { count?: number \| undefined; hosts?: { total: number; values: { name: string \| undefined; id: string; count: number; }[]; } \| undefined; users?: { total: number; values: { name: string; count: number; }[]; } \| undefined; } ; `connectors`: `undefined` \| { `total`: `number` = rt.number } ; `lifespan`: `undefined` \| { `closeDate`: ``null`` \| `string` ; `creationDate`: `string` = rt.string; `statusInfo`: { openDuration: number; inProgressDuration: number; reopenDates: string[]; } = StatusInfoRt } }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`CaseMetricsParams`](metrics_client._internal_namespace.CaseMetricsParams.md) | - -#### Returns - -`Promise`<{ `actions`: `undefined` \| { isolateHost?: { isolate: { total: number; }; unisolate: { total: number; }; } \| undefined; } ; `alerts`: `undefined` \| { count?: number \| undefined; hosts?: { total: number; values: { name: string \| undefined; id: string; count: number; }[]; } \| undefined; users?: { total: number; values: { name: string; count: number; }[]; } \| undefined; } ; `connectors`: `undefined` \| { `total`: `number` = rt.number } ; `lifespan`: `undefined` \| { `closeDate`: ``null`` \| `string` ; `creationDate`: `string` = rt.string; `statusInfo`: { openDuration: number; inProgressDuration: number; reopenDates: string[]; } = StatusInfoRt } }\> - -#### Defined in - -[x-pack/plugins/cases/server/client/metrics/client.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/client.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client._internal_namespace.CaseMetricsParams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client._internal_namespace.CaseMetricsParams.md deleted file mode 100644 index 8f03bed67e646d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client._internal_namespace.CaseMetricsParams.md +++ /dev/null @@ -1,36 +0,0 @@ -[Cases Client API Interface](../README.md) / [metrics/client](../modules/metrics_client.md) / [\_internal\_namespace](../modules/metrics_client._internal_namespace.md) / CaseMetricsParams - -# Interface: CaseMetricsParams - -[metrics/client](../modules/metrics_client.md).[_internal_namespace](../modules/metrics_client._internal_namespace.md).CaseMetricsParams - -## Table of contents - -### Properties - -- [caseId](metrics_client._internal_namespace.CaseMetricsParams.md#caseid) -- [features](metrics_client._internal_namespace.CaseMetricsParams.md#features) - -## Properties - -### caseId - -• **caseId**: `string` - -The ID of the case. - -#### Defined in - -[x-pack/plugins/cases/server/client/metrics/get_case_metrics.ts:26](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/get_case_metrics.ts#L26) - -___ - -### features - -• **features**: `string`[] - -The metrics to retrieve. - -#### Defined in - -[x-pack/plugins/cases/server/client/metrics/get_case_metrics.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/get_case_metrics.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/stats_client.statssubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/stats_client.statssubclient.md deleted file mode 100644 index 37dab1782ee06f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/stats_client.statssubclient.md +++ /dev/null @@ -1,36 +0,0 @@ -[Cases Client API Interface](../README.md) / [stats/client](../modules/stats_client.md) / StatsSubClient - -# Interface: StatsSubClient - -[stats/client](../modules/stats_client.md).StatsSubClient - -Statistics API contract. - -## Table of contents - -### Methods - -- [getStatusTotalsByType](stats_client.StatsSubClient.md#getstatustotalsbytype) - -## Methods - -### getStatusTotalsByType - -▸ **getStatusTotalsByType**(`params`): `Promise`<{ `count_closed_cases`: `number` = rt.number; `count_in_progress_cases`: `number` = rt.number; `count_open_cases`: `number` = rt.number }\> - -Retrieves the total number of open, closed, and in-progress cases. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.owner` | `undefined` \| `string` \| `string`[] | - -#### Returns - -`Promise`<{ `count_closed_cases`: `number` = rt.number; `count_in_progress_cases`: `number` = rt.number; `count_open_cases`: `number` = rt.number }\> - -#### Defined in - -[x-pack/plugins/cases/server/client/stats/client.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/stats/client.ts#L34) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.ICaseResolveResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.ICaseResolveResponse.md deleted file mode 100644 index a428247ab70ba7..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.ICaseResolveResponse.md +++ /dev/null @@ -1,49 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICaseResolveResponse - -# Interface: ICaseResolveResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICaseResolveResponse - -## Hierarchy - -- [`CaseResolveResponse`](../modules/typedoc_interfaces._internal_namespace.md#caseresolveresponse) - - ↳ **`ICaseResolveResponse`** - -## Table of contents - -### Properties - -- [alias\_target\_id](typedoc_interfaces.ICaseResolveResponse.md#alias_target_id) -- [case](typedoc_interfaces.ICaseResolveResponse.md#case) -- [outcome](typedoc_interfaces.ICaseResolveResponse.md#outcome) - -## Properties - -### alias\_target\_id - -• **alias\_target\_id**: `undefined` \| `string` = `rt.string` - -#### Inherited from - -CaseResolveResponse.alias\_target\_id - -___ - -### case - -• **case**: { `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `totalAlerts`: `number` = rt.number; `totalComment`: `number` = rt.number; `version`: `string` = rt.string } & { `comments`: `undefined` \| { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] } = `CaseResponseRt` - -#### Inherited from - -CaseResolveResponse.case - -___ - -### outcome - -• **outcome**: ``"exactMatch"`` \| ``"aliasMatch"`` \| ``"conflict"`` - -#### Inherited from - -CaseResolveResponse.outcome diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.iallcommentsresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.iallcommentsresponse.md deleted file mode 100644 index e4d0d7cdaa594f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.iallcommentsresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / IAllCommentsResponse - -# Interface: IAllCommentsResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).IAllCommentsResponse - -## Hierarchy - -- [`AllCommentsResponse`](../modules/typedoc_interfaces._internal_namespace.md#allcommentsresponse) - - ↳ **`IAllCommentsResponse`** diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasepostrequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasepostrequest.md deleted file mode 100644 index bcca7301539f57..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasepostrequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasePostRequest - -# Interface: ICasePostRequest - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICasePostRequest - -These are simply to make typedoc not attempt to expand the type aliases. If it attempts to expand them -the docs are huge. - -## Hierarchy - -- [`CasePostRequest`](../modules/typedoc_interfaces._internal_namespace.md#casepostrequest) - - ↳ **`ICasePostRequest`** - -## Table of contents - -### Properties - -- [connector](typedoc_interfaces.ICasePostRequest.md#connector) -- [description](typedoc_interfaces.ICasePostRequest.md#description) -- [owner](typedoc_interfaces.ICasePostRequest.md#owner) -- [settings](typedoc_interfaces.ICasePostRequest.md#settings) -- [tags](typedoc_interfaces.ICasePostRequest.md#tags) -- [title](typedoc_interfaces.ICasePostRequest.md#title) - -## Properties - -### connector - -• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` - -#### Inherited from - -CasePostRequest.connector - -___ - -### description - -• **description**: `string` = `rt.string` - -#### Inherited from - -CasePostRequest.description - -___ - -### owner - -• **owner**: `string` = `rt.string` - -#### Inherited from - -CasePostRequest.owner - -___ - -### settings - -• **settings**: `Object` = `SettingsRt` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `syncAlerts` | `boolean` | - -#### Inherited from - -CasePostRequest.settings - -___ - -### tags - -• **tags**: `string`[] - -#### Inherited from - -CasePostRequest.tags - -___ - -### title - -• **title**: `string` = `rt.string` - -#### Inherited from - -CasePostRequest.title diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseresponse.md deleted file mode 100644 index 5a323c80957689..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseresponse.md +++ /dev/null @@ -1,239 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICaseResponse - -# Interface: ICaseResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICaseResponse - -## Hierarchy - -- [`CaseResponse`](../modules/typedoc_interfaces._internal_namespace.md#caseresponse) - - ↳ **`ICaseResponse`** - -## Table of contents - -### Properties - -- [closed\_at](typedoc_interfaces.ICaseResponse.md#closed_at) -- [closed\_by](typedoc_interfaces.ICaseResponse.md#closed_by) -- [comments](typedoc_interfaces.ICaseResponse.md#comments) -- [connector](typedoc_interfaces.ICaseResponse.md#connector) -- [created\_at](typedoc_interfaces.ICaseResponse.md#created_at) -- [created\_by](typedoc_interfaces.ICaseResponse.md#created_by) -- [description](typedoc_interfaces.ICaseResponse.md#description) -- [external\_service](typedoc_interfaces.ICaseResponse.md#external_service) -- [id](typedoc_interfaces.ICaseResponse.md#id) -- [owner](typedoc_interfaces.ICaseResponse.md#owner) -- [settings](typedoc_interfaces.ICaseResponse.md#settings) -- [status](typedoc_interfaces.ICaseResponse.md#status) -- [tags](typedoc_interfaces.ICaseResponse.md#tags) -- [title](typedoc_interfaces.ICaseResponse.md#title) -- [totalAlerts](typedoc_interfaces.ICaseResponse.md#totalalerts) -- [totalComment](typedoc_interfaces.ICaseResponse.md#totalcomment) -- [updated\_at](typedoc_interfaces.ICaseResponse.md#updated_at) -- [updated\_by](typedoc_interfaces.ICaseResponse.md#updated_by) -- [version](typedoc_interfaces.ICaseResponse.md#version) - -## Properties - -### closed\_at - -• **closed\_at**: ``null`` \| `string` - -#### Inherited from - -CaseResponse.closed\_at - -___ - -### closed\_by - -• **closed\_by**: ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } - -#### Inherited from - -CaseResponse.closed\_by - -___ - -### comments - -• **comments**: `undefined` \| { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] - -#### Inherited from - -CaseResponse.comments - -___ - -### connector - -• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` - -#### Inherited from - -CaseResponse.connector - -___ - -### created\_at - -• **created\_at**: `string` = `rt.string` - -#### Inherited from - -CaseResponse.created\_at - -___ - -### created\_by - -• **created\_by**: `Object` = `UserRT` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Inherited from - -CaseResponse.created\_by - -___ - -### description - -• **description**: `string` = `rt.string` - -#### Inherited from - -CaseResponse.description - -___ - -### external\_service - -• **external\_service**: ``null`` \| { `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT } = `CaseFullExternalServiceRt` - -#### Inherited from - -CaseResponse.external\_service - -___ - -### id - -• **id**: `string` = `rt.string` - -#### Inherited from - -CaseResponse.id - -___ - -### owner - -• **owner**: `string` = `rt.string` - -#### Inherited from - -CaseResponse.owner - -___ - -### settings - -• **settings**: `Object` = `SettingsRt` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `syncAlerts` | `boolean` | - -#### Inherited from - -CaseResponse.settings - -___ - -### status - -• **status**: `CaseStatuses` = `CaseStatusRt` - -#### Inherited from - -CaseResponse.status - -___ - -### tags - -• **tags**: `string`[] - -#### Inherited from - -CaseResponse.tags - -___ - -### title - -• **title**: `string` = `rt.string` - -#### Inherited from - -CaseResponse.title - -___ - -### totalAlerts - -• **totalAlerts**: `number` = `rt.number` - -#### Inherited from - -CaseResponse.totalAlerts - -___ - -### totalComment - -• **totalComment**: `number` = `rt.number` - -#### Inherited from - -CaseResponse.totalComment - -___ - -### updated\_at - -• **updated\_at**: ``null`` \| `string` - -#### Inherited from - -CaseResponse.updated\_at - -___ - -### updated\_by - -• **updated\_by**: ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } - -#### Inherited from - -CaseResponse.updated\_by - -___ - -### version - -• **version**: `string` = `rt.string` - -#### Inherited from - -CaseResponse.version diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurepatch.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurepatch.md deleted file mode 100644 index b645740febc081..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurepatch.md +++ /dev/null @@ -1,49 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigurePatch - -# Interface: ICasesConfigurePatch - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICasesConfigurePatch - -## Hierarchy - -- [`CasesConfigurePatch`](../modules/typedoc_interfaces._internal_namespace.md#casesconfigurepatch) - - ↳ **`ICasesConfigurePatch`** - -## Table of contents - -### Properties - -- [closure\_type](typedoc_interfaces.ICasesConfigurePatch.md#closure_type) -- [connector](typedoc_interfaces.ICasesConfigurePatch.md#connector) -- [version](typedoc_interfaces.ICasesConfigurePatch.md#version) - -## Properties - -### closure\_type - -• **closure\_type**: `undefined` \| ``"close-by-user"`` \| ``"close-by-pushing"`` = `ClosureTypeRT` - -#### Inherited from - -CasesConfigurePatch.closure\_type - -___ - -### connector - -• **connector**: `undefined` \| { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` - -#### Inherited from - -CasesConfigurePatch.connector - -___ - -### version - -• **version**: `string` = `rt.string` - -#### Inherited from - -CasesConfigurePatch.version diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurerequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurerequest.md deleted file mode 100644 index 5dc7249d20f570..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurerequest.md +++ /dev/null @@ -1,49 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigureRequest - -# Interface: ICasesConfigureRequest - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICasesConfigureRequest - -## Hierarchy - -- [`CasesConfigureRequest`](../modules/typedoc_interfaces._internal_namespace.md#casesconfigurerequest) - - ↳ **`ICasesConfigureRequest`** - -## Table of contents - -### Properties - -- [closure\_type](typedoc_interfaces.ICasesConfigureRequest.md#closure_type) -- [connector](typedoc_interfaces.ICasesConfigureRequest.md#connector) -- [owner](typedoc_interfaces.ICasesConfigureRequest.md#owner) - -## Properties - -### closure\_type - -• **closure\_type**: ``"close-by-user"`` \| ``"close-by-pushing"`` = `ClosureTypeRT` - -#### Inherited from - -CasesConfigureRequest.closure\_type - -___ - -### connector - -• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` - -#### Inherited from - -CasesConfigureRequest.connector - -___ - -### owner - -• **owner**: `string` = `rt.string` - -#### Inherited from - -CasesConfigureRequest.owner diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigureresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigureresponse.md deleted file mode 100644 index 20754bcaa22b6f..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigureresponse.md +++ /dev/null @@ -1,145 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigureResponse - -# Interface: ICasesConfigureResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICasesConfigureResponse - -## Hierarchy - -- [`CasesConfigureResponse`](../modules/typedoc_interfaces._internal_namespace.md#casesconfigureresponse) - - ↳ **`ICasesConfigureResponse`** - -## Table of contents - -### Properties - -- [closure\_type](typedoc_interfaces.ICasesConfigureResponse.md#closure_type) -- [connector](typedoc_interfaces.ICasesConfigureResponse.md#connector) -- [created\_at](typedoc_interfaces.ICasesConfigureResponse.md#created_at) -- [created\_by](typedoc_interfaces.ICasesConfigureResponse.md#created_by) -- [error](typedoc_interfaces.ICasesConfigureResponse.md#error) -- [id](typedoc_interfaces.ICasesConfigureResponse.md#id) -- [mappings](typedoc_interfaces.ICasesConfigureResponse.md#mappings) -- [owner](typedoc_interfaces.ICasesConfigureResponse.md#owner) -- [updated\_at](typedoc_interfaces.ICasesConfigureResponse.md#updated_at) -- [updated\_by](typedoc_interfaces.ICasesConfigureResponse.md#updated_by) -- [version](typedoc_interfaces.ICasesConfigureResponse.md#version) - -## Properties - -### closure\_type - -• **closure\_type**: ``"close-by-user"`` \| ``"close-by-pushing"`` = `ClosureTypeRT` - -#### Inherited from - -CasesConfigureResponse.closure\_type - -___ - -### connector - -• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` - -#### Inherited from - -CasesConfigureResponse.connector - -___ - -### created\_at - -• **created\_at**: `string` = `rt.string` - -#### Inherited from - -CasesConfigureResponse.created\_at - -___ - -### created\_by - -• **created\_by**: `Object` = `UserRT` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `email` | `undefined` \| ``null`` \| `string` | -| `full_name` | `undefined` \| ``null`` \| `string` | -| `username` | `undefined` \| ``null`` \| `string` | - -#### Inherited from - -CasesConfigureResponse.created\_by - -___ - -### error - -• **error**: ``null`` \| `string` - -#### Inherited from - -CasesConfigureResponse.error - -___ - -### id - -• **id**: `string` = `rt.string` - -#### Inherited from - -CasesConfigureResponse.id - -___ - -### mappings - -• **mappings**: { `action_type`: ``"append"`` \| ``"nothing"`` \| ``"overwrite"`` = ActionTypeRT; `source`: ``"description"`` \| ``"title"`` \| ``"comments"`` = CaseFieldRT; `target`: `string` = ThirdPartyFieldRT }[] - -#### Inherited from - -CasesConfigureResponse.mappings - -___ - -### owner - -• **owner**: `string` = `rt.string` - -#### Inherited from - -CasesConfigureResponse.owner - -___ - -### updated\_at - -• **updated\_at**: ``null`` \| `string` - -#### Inherited from - -CasesConfigureResponse.updated\_at - -___ - -### updated\_by - -• **updated\_by**: ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } - -#### Inherited from - -CasesConfigureResponse.updated\_by - -___ - -### version - -• **version**: `string` = `rt.string` - -#### Inherited from - -CasesConfigureResponse.version diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindrequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindrequest.md deleted file mode 100644 index b9cc22c6eee448..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindrequest.md +++ /dev/null @@ -1,148 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesFindRequest - -# Interface: ICasesFindRequest - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICasesFindRequest - -## Hierarchy - -- [`CasesFindRequest`](../modules/client._internal_namespace.md#casesfindrequest) - - ↳ **`ICasesFindRequest`** - -## Table of contents - -### Properties - -- [defaultSearchOperator](typedoc_interfaces.ICasesFindRequest.md#defaultsearchoperator) -- [fields](typedoc_interfaces.ICasesFindRequest.md#fields) -- [owner](typedoc_interfaces.ICasesFindRequest.md#owner) -- [page](typedoc_interfaces.ICasesFindRequest.md#page) -- [perPage](typedoc_interfaces.ICasesFindRequest.md#perpage) -- [reporters](typedoc_interfaces.ICasesFindRequest.md#reporters) -- [search](typedoc_interfaces.ICasesFindRequest.md#search) -- [searchFields](typedoc_interfaces.ICasesFindRequest.md#searchfields) -- [sortField](typedoc_interfaces.ICasesFindRequest.md#sortfield) -- [sortOrder](typedoc_interfaces.ICasesFindRequest.md#sortorder) -- [status](typedoc_interfaces.ICasesFindRequest.md#status) -- [tags](typedoc_interfaces.ICasesFindRequest.md#tags) - -## Properties - -### defaultSearchOperator - -• **defaultSearchOperator**: `undefined` \| ``"AND"`` \| ``"OR"`` - -#### Inherited from - -CasesFindRequest.defaultSearchOperator - -___ - -### fields - -• **fields**: `undefined` \| `string`[] - -#### Inherited from - -CasesFindRequest.fields - -___ - -### owner - -• **owner**: `undefined` \| `string` \| `string`[] - -#### Inherited from - -CasesFindRequest.owner - -___ - -### page - -• **page**: `undefined` \| `number` = `NumberFromString` - -#### Inherited from - -CasesFindRequest.page - -___ - -### perPage - -• **perPage**: `undefined` \| `number` = `NumberFromString` - -#### Inherited from - -CasesFindRequest.perPage - -___ - -### reporters - -• **reporters**: `undefined` \| `string` \| `string`[] - -#### Inherited from - -CasesFindRequest.reporters - -___ - -### search - -• **search**: `undefined` \| `string` = `rt.string` - -#### Inherited from - -CasesFindRequest.search - -___ - -### searchFields - -• **searchFields**: `undefined` \| `string` \| `string`[] - -#### Inherited from - -CasesFindRequest.searchFields - -___ - -### sortField - -• **sortField**: `undefined` \| `string` = `rt.string` - -#### Inherited from - -CasesFindRequest.sortField - -___ - -### sortOrder - -• **sortOrder**: `undefined` \| ``"desc"`` \| ``"asc"`` - -#### Inherited from - -CasesFindRequest.sortOrder - -___ - -### status - -• **status**: `undefined` \| [`open`](../enums/client._internal_namespace.CaseStatuses.md#open) \| `any`[`any`] \| [`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed) = `CaseStatusRt` - -#### Inherited from - -CasesFindRequest.status - -___ - -### tags - -• **tags**: `undefined` \| `string` \| `string`[] - -#### Inherited from - -CasesFindRequest.tags diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindresponse.md deleted file mode 100644 index 16b88c29d4d8e1..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindresponse.md +++ /dev/null @@ -1,93 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesFindResponse - -# Interface: ICasesFindResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICasesFindResponse - -## Hierarchy - -- [`CasesFindResponse`](../modules/typedoc_interfaces._internal_namespace.md#casesfindresponse) - - ↳ **`ICasesFindResponse`** - -## Table of contents - -### Properties - -- [cases](typedoc_interfaces.ICasesFindResponse.md#cases) -- [count\_closed\_cases](typedoc_interfaces.ICasesFindResponse.md#count_closed_cases) -- [count\_in\_progress\_cases](typedoc_interfaces.ICasesFindResponse.md#count_in_progress_cases) -- [count\_open\_cases](typedoc_interfaces.ICasesFindResponse.md#count_open_cases) -- [page](typedoc_interfaces.ICasesFindResponse.md#page) -- [per\_page](typedoc_interfaces.ICasesFindResponse.md#per_page) -- [total](typedoc_interfaces.ICasesFindResponse.md#total) - -## Properties - -### cases - -• **cases**: { `connector`: { 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: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `totalAlerts`: `number` = rt.number; `totalComment`: `number` = rt.number; `version`: `string` = rt.string } & { `comments`: `undefined` \| { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] }[] - -#### Inherited from - -CasesFindResponse.cases - -___ - -### count\_closed\_cases - -• **count\_closed\_cases**: `number` = `rt.number` - -#### Inherited from - -CasesFindResponse.count\_closed\_cases - -___ - -### count\_in\_progress\_cases - -• **count\_in\_progress\_cases**: `number` = `rt.number` - -#### Inherited from - -CasesFindResponse.count\_in\_progress\_cases - -___ - -### count\_open\_cases - -• **count\_open\_cases**: `number` = `rt.number` - -#### Inherited from - -CasesFindResponse.count\_open\_cases - -___ - -### page - -• **page**: `number` = `rt.number` - -#### Inherited from - -CasesFindResponse.page - -___ - -### per\_page - -• **per\_page**: `number` = `rt.number` - -#### Inherited from - -CasesFindResponse.per\_page - -___ - -### total - -• **total**: `number` = `rt.number` - -#### Inherited from - -CasesFindResponse.total diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasespatchrequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasespatchrequest.md deleted file mode 100644 index 5cf299204ef13e..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasespatchrequest.md +++ /dev/null @@ -1,27 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesPatchRequest - -# Interface: ICasesPatchRequest - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICasesPatchRequest - -## Hierarchy - -- [`CasesPatchRequest`](../modules/typedoc_interfaces._internal_namespace.md#casespatchrequest) - - ↳ **`ICasesPatchRequest`** - -## Table of contents - -### Properties - -- [cases](typedoc_interfaces.ICasesPatchRequest.md#cases) - -## Properties - -### cases - -• **cases**: { `connector`: `undefined` \| { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = CaseConnectorRt; `description`: `undefined` \| `string` = rt.string; `owner`: `undefined` \| `string` = rt.string; `settings`: `undefined` \| { `syncAlerts`: `boolean` = rt.boolean } = SettingsRt; `status`: `undefined` \| [`open`](../enums/client._internal_namespace.CaseStatuses.md#open) \| `any`[`any`] \| [`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed) = CaseStatusRt; `tags`: `undefined` \| `string`[] ; `title`: `undefined` \| `string` = rt.string } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] - -#### Inherited from - -CasesPatchRequest.cases diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesresponse.md deleted file mode 100644 index 250ac66e4a6807..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesResponse - -# Interface: ICasesResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICasesResponse - -## Hierarchy - -- [`CasesResponse`](../modules/typedoc_interfaces._internal_namespace.md#casesresponse) - - ↳ **`ICasesResponse`** diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseuseractionsresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseuseractionsresponse.md deleted file mode 100644 index d3b936903e42c9..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseuseractionsresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICaseUserActionsResponse - -# Interface: ICaseUserActionsResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICaseUserActionsResponse - -## Hierarchy - -- [`CaseUserActionsResponse`](../modules/typedoc_interfaces._internal_namespace.md#caseuseractionsresponse) - - ↳ **`ICaseUserActionsResponse`** diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icommentsresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icommentsresponse.md deleted file mode 100644 index 012b28393f5b96..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icommentsresponse.md +++ /dev/null @@ -1,60 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICommentsResponse - -# Interface: ICommentsResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ICommentsResponse - -## Hierarchy - -- [`CommentsResponse`](../modules/typedoc_interfaces._internal_namespace.md#commentsresponse) - - ↳ **`ICommentsResponse`** - -## Table of contents - -### Properties - -- [comments](typedoc_interfaces.ICommentsResponse.md#comments) -- [page](typedoc_interfaces.ICommentsResponse.md#page) -- [per\_page](typedoc_interfaces.ICommentsResponse.md#per_page) -- [total](typedoc_interfaces.ICommentsResponse.md#total) - -## Properties - -### comments - -• **comments**: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] - -#### Inherited from - -CommentsResponse.comments - -___ - -### page - -• **page**: `number` = `rt.number` - -#### Inherited from - -CommentsResponse.page - -___ - -### per\_page - -• **per\_page**: `number` = `rt.number` - -#### Inherited from - -CommentsResponse.per\_page - -___ - -### total - -• **total**: `number` = `rt.number` - -#### Inherited from - -CommentsResponse.total diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionget.md b/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionget.md deleted file mode 100644 index 8650aed9753f1d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionget.md +++ /dev/null @@ -1,25 +0,0 @@ -[Cases Client API Interface](../README.md) / [user\_actions/client](../modules/user_actions_client.md) / UserActionGet - -# Interface: UserActionGet - -[user_actions/client](../modules/user_actions_client.md).UserActionGet - -Parameters for retrieving user actions for a particular case - -## Table of contents - -### Properties - -- [caseId](user_actions_client.UserActionGet.md#caseid) - -## Properties - -### caseId - -• **caseId**: `string` - -The ID of the case - -#### Defined in - -[x-pack/plugins/cases/server/client/user_actions/client.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/user_actions/client.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionssubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionssubclient.md deleted file mode 100644 index 0cf541f5cc445d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionssubclient.md +++ /dev/null @@ -1,35 +0,0 @@ -[Cases Client API Interface](../README.md) / [user\_actions/client](../modules/user_actions_client.md) / UserActionsSubClient - -# Interface: UserActionsSubClient - -[user_actions/client](../modules/user_actions_client.md).UserActionsSubClient - -API for interacting the actions performed by a user when interacting with the cases entities. - -## Table of contents - -### Methods - -- [getAll](user_actions_client.UserActionsSubClient.md#getall) - -## Methods - -### getAll - -▸ **getAll**(`clientArgs`): `Promise`<[`ICaseUserActionsResponse`](typedoc_interfaces.ICaseUserActionsResponse.md)\> - -Retrieves all user actions for a particular case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `clientArgs` | [`UserActionGet`](user_actions_client.UserActionGet.md) | - -#### Returns - -`Promise`<[`ICaseUserActionsResponse`](typedoc_interfaces.ICaseUserActionsResponse.md)\> - -#### Defined in - -[x-pack/plugins/cases/server/client/user_actions/client.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/user_actions/client.ts#L29) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/attachments_client._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/attachments_client._internal_namespace.md deleted file mode 100644 index 953648379c08fd..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/attachments_client._internal_namespace.md +++ /dev/null @@ -1,18 +0,0 @@ -[Cases Client API Interface](../README.md) / [attachments/client](attachments_client.md) / \_internal\_namespace - -# Namespace: \_internal\_namespace - -[attachments/client](attachments_client.md)._internal_namespace - -## Table of contents - -### Interfaces - -- [AddArgs](../interfaces/attachments_client._internal_namespace.AddArgs.md) -- [DeleteAllArgs](../interfaces/attachments_client._internal_namespace.DeleteAllArgs.md) -- [DeleteArgs](../interfaces/attachments_client._internal_namespace.DeleteArgs.md) -- [FindArgs](../interfaces/attachments_client._internal_namespace.FindArgs.md) -- [GetAllAlertsAttachToCase](../interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md) -- [GetAllArgs](../interfaces/attachments_client._internal_namespace.GetAllArgs.md) -- [GetArgs](../interfaces/attachments_client._internal_namespace.GetArgs.md) -- [UpdateArgs](../interfaces/attachments_client._internal_namespace.UpdateArgs.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/attachments_client.md b/x-pack/plugins/cases/docs/cases_client/modules/attachments_client.md deleted file mode 100644 index 2463e2c654e937..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/attachments_client.md +++ /dev/null @@ -1,13 +0,0 @@ -[Cases Client API Interface](../README.md) / attachments/client - -# Module: attachments/client - -## Table of contents - -### Namespaces - -- [\_internal\_namespace](attachments_client._internal_namespace.md) - -### Interfaces - -- [AttachmentsSubClient](../interfaces/attachments_client.AttachmentsSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/cases_client.md b/x-pack/plugins/cases/docs/cases_client/modules/cases_client.md deleted file mode 100644 index daf591f75c1f8d..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/cases_client.md +++ /dev/null @@ -1,9 +0,0 @@ -[Cases Client API Interface](../README.md) / cases/client - -# Module: cases/client - -## Table of contents - -### Interfaces - -- [CasesSubClient](../interfaces/cases_client.CasesSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/cases_get._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/cases_get._internal_namespace.md deleted file mode 100644 index a43b25f69372f3..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/cases_get._internal_namespace.md +++ /dev/null @@ -1,35 +0,0 @@ -[Cases Client API Interface](../README.md) / [cases/get](cases_get.md) / \_internal\_namespace - -# Namespace: \_internal\_namespace - -[cases/get](cases_get.md)._internal_namespace - -## Table of contents - -### Type aliases - -- [User](cases_get._internal_namespace.md#user) - -### Variables - -- [UserRT](cases_get._internal_namespace.md#userrt) - -## Type aliases - -### User - -Ƭ **User**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/user.ts:18](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/user.ts#L18) - -## Variables - -### UserRT - -• **UserRT**: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> - -#### Defined in - -[x-pack/plugins/cases/common/api/user.ts:10](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/user.ts#L10) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/cases_get.md b/x-pack/plugins/cases/docs/cases_client/modules/cases_get.md deleted file mode 100644 index 6dbf7bb10d0a3b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/cases_get.md +++ /dev/null @@ -1,93 +0,0 @@ -[Cases Client API Interface](../README.md) / cases/get - -# Module: cases/get - -## Table of contents - -### Namespaces - -- [\_internal\_namespace](cases_get._internal_namespace.md) - -### Interfaces - -- [CasesByAlertIDParams](../interfaces/cases_get.CasesByAlertIDParams.md) -- [GetParams](../interfaces/cases_get.GetParams.md) - -### Functions - -- [getReporters](cases_get.md#getreporters) -- [getTags](cases_get.md#gettags) -- [resolve](cases_get.md#resolve) - -## Functions - -### getReporters - -▸ **getReporters**(`params`, `clientArgs`): `Promise`<[`User`](cases_get._internal_namespace.md#user)[]\> - -Retrieves the reporters from all the cases. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.owner` | `undefined` \| `string` \| `string`[] | -| `clientArgs` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | - -#### Returns - -`Promise`<[`User`](cases_get._internal_namespace.md#user)[]\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/get.ts:301](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L301) - -___ - -### getTags - -▸ **getTags**(`params`, `clientArgs`): `Promise`<`string`[]\> - -Retrieves the tags from all the cases. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.owner` | `undefined` \| `string` \| `string`[] | -| `clientArgs` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/get.ts:269](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L269) - -___ - -### resolve - -▸ `Const` **resolve**(`__namedParameters`, `clientArgs`): `Promise`<{ `case`: { description: string; status: CaseStatuses; tags: string[]; title: string; connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { ...; }) \| ... 4 more ... \| ({ ...; } & { ...; })); settings: { ...; }; owner: str... & { closed\_at: string \| null; closed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } \| null; created\_at: string; created\_by: { ...; }; external\_service: ({ ...; } & { ...; }) \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { `comments`: `undefined` \| { comment: string; type: CommentType.user; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; } & { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; } & { type: CommentType.actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; }[] } = CaseResponseRt; `outcome`: ``"exactMatch"`` \| ``"aliasMatch"`` \| ``"conflict"`` } & { `alias_target_id`: `undefined` \| `string` = rt.string }\> - -Retrieves a case resolving its ID and optionally loading its comments. - -**`experimental`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`GetParams`](../interfaces/cases_get.GetParams.md) | -| `clientArgs` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | - -#### Returns - -`Promise`<{ `case`: { description: string; status: CaseStatuses; tags: string[]; title: string; connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { ...; }) \| ... 4 more ... \| ({ ...; } & { ...; })); settings: { ...; }; owner: str... & { closed\_at: string \| null; closed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } \| null; created\_at: string; created\_by: { ...; }; external\_service: ({ ...; } & { ...; }) \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { `comments`: `undefined` \| { comment: string; type: CommentType.user; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; } & { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; } & { type: CommentType.actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; }[] } = CaseResponseRt; `outcome`: ``"exactMatch"`` \| ``"aliasMatch"`` \| ``"conflict"`` } & { `alias_target_id`: `undefined` \| `string` = rt.string }\> - -#### Defined in - -[x-pack/plugins/cases/server/client/cases/get.ts:208](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L208) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/cases_push.md b/x-pack/plugins/cases/docs/cases_client/modules/cases_push.md deleted file mode 100644 index bb9667b3308dbc..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/cases_push.md +++ /dev/null @@ -1,9 +0,0 @@ -[Cases Client API Interface](../README.md) / cases/push - -# Module: cases/push - -## Table of contents - -### Interfaces - -- [PushParams](../interfaces/cases_push.PushParams.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/client._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/client._internal_namespace.md deleted file mode 100644 index 4489106b370d1b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/client._internal_namespace.md +++ /dev/null @@ -1,2213 +0,0 @@ -[Cases Client API Interface](../README.md) / [client](client.md) / \_internal\_namespace - -# Namespace: \_internal\_namespace - -[client](client.md)._internal_namespace - -## Table of contents - -### Enumerations - -- [ActionExecutionSourceType](../enums/client._internal_namespace.ActionExecutionSourceType.md) -- [AuthorizationMode](../enums/client._internal_namespace.AuthorizationMode.md) -- [CaseStatuses](../enums/client._internal_namespace.CaseStatuses.md) -- [TaskStatus](../enums/client._internal_namespace.TaskStatus.md) -- [ViewMode](../enums/client._internal_namespace.ViewMode.md) - -### Enumeration members - -- [actions](client._internal_namespace.md#actions) -- [alert](client._internal_namespace.md#alert) -- [jira](client._internal_namespace.md#jira) -- [none](client._internal_namespace.md#none) -- [resilient](client._internal_namespace.md#resilient) -- [serviceNowITSM](client._internal_namespace.md#servicenowitsm) -- [serviceNowSIR](client._internal_namespace.md#servicenowsir) -- [swimlane](client._internal_namespace.md#swimlane) -- [user](client._internal_namespace.md#user) - -### Classes - -- [ActionExecutor](../classes/client._internal_namespace.ActionExecutor.md) -- [ActionTypeRegistry](../classes/client._internal_namespace.ActionTypeRegistry.md) -- [Actions](../classes/client._internal_namespace.Actions.md) -- [ActionsAuthorization](../classes/client._internal_namespace.ActionsAuthorization.md) -- [ActionsClient](../classes/client._internal_namespace.ActionsClient.md) -- [AlertService](../classes/client._internal_namespace.AlertService.md) -- [AlertingActions](../classes/client._internal_namespace.AlertingActions.md) -- [ApiActions](../classes/client._internal_namespace.ApiActions.md) -- [AppActions](../classes/client._internal_namespace.AppActions.md) -- [AttachmentService](../classes/client._internal_namespace.AttachmentService.md) -- [Authorization](../classes/client._internal_namespace.Authorization.md) -- [AuthorizationAuditLogger](../classes/client._internal_namespace.AuthorizationAuditLogger.md) -- [BasePath](../classes/client._internal_namespace.BasePath.md) -- [BuilderFactory](../classes/client._internal_namespace.BuilderFactory.md) -- [CaseConfigureService](../classes/client._internal_namespace.CaseConfigureService.md) -- [CaseUserActionService](../classes/client._internal_namespace.CaseUserActionService.md) -- [CasesActions](../classes/client._internal_namespace.CasesActions.md) -- [CasesClientInternal](../classes/client._internal_namespace.CasesClientInternal.md) -- [CasesService](../classes/client._internal_namespace.CasesService.md) -- [ConnectorMappingsService](../classes/client._internal_namespace.ConnectorMappingsService.md) -- [ConnectorTokenClient](../classes/client._internal_namespace.ConnectorTokenClient.md) -- [ElasticsearchFeature](../classes/client._internal_namespace.ElasticsearchFeature.md) -- [KibanaFeature](../classes/client._internal_namespace.KibanaFeature.md) -- [KibanaMigrator](../classes/client._internal_namespace.KibanaMigrator.md) -- [KibanaRequest](../classes/client._internal_namespace.KibanaRequest.md) -- [LicenseState](../classes/client._internal_namespace.LicenseState.md) -- [RouteValidationError](../classes/client._internal_namespace.RouteValidationError.md) -- [RouteValidator](../classes/client._internal_namespace.RouteValidator.md) -- [SavedObjectActions](../classes/client._internal_namespace.SavedObjectActions.md) -- [SavedObjectTypeRegistry](../classes/client._internal_namespace.SavedObjectTypeRegistry.md) -- [SavedObjectsClient](../classes/client._internal_namespace.SavedObjectsClient.md) -- [SavedObjectsErrorHelpers](../classes/client._internal_namespace.SavedObjectsErrorHelpers.md) -- [SavedObjectsRepository](../classes/client._internal_namespace.SavedObjectsRepository.md) -- [SpaceActions](../classes/client._internal_namespace.SpaceActions.md) -- [SubFeature](../classes/client._internal_namespace.SubFeature.md) -- [TaskRunnerFactory](../classes/client._internal_namespace.TaskRunnerFactory.md) -- [UIActions](../classes/client._internal_namespace.UIActions.md) -- [UserActionBuilder](../classes/client._internal_namespace.UserActionBuilder.md) - -### Interfaces - -- [Action](../interfaces/client._internal_namespace.Action.md) -- [ActionExecutionSource](../interfaces/client._internal_namespace.ActionExecutionSource.md) -- [ActionExecutorContext](../interfaces/client._internal_namespace.ActionExecutorContext.md) -- [ActionResult](../interfaces/client._internal_namespace.ActionResult.md) -- [ActionType](../interfaces/client._internal_namespace.ActionType.md) -- [ActionType](../interfaces/client._internal_namespace.ActionType-1.md) -- [ActionTypeExecutorOptions](../interfaces/client._internal_namespace.ActionTypeExecutorOptions.md) -- [ActionTypeExecutorResult](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md) -- [ActionTypeRegistryOpts](../interfaces/client._internal_namespace.ActionTypeRegistryOpts.md) -- [ActionUpdate](../interfaces/client._internal_namespace.ActionUpdate.md) -- [ActionsConfigurationUtilities](../interfaces/client._internal_namespace.ActionsConfigurationUtilities.md) -- [ActionsLicenseInformation](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) -- [AggregationBuilder](../interfaces/client._internal_namespace.AggregationBuilder.md) -- [Alert](../interfaces/client._internal_namespace.Alert.md) -- [AlertIdIndex](../interfaces/client._internal_namespace.AlertIdIndex.md) -- [AlertInfo](../interfaces/client._internal_namespace.AlertInfo.md) -- [AlertsResponse](../interfaces/client._internal_namespace.AlertsResponse.md) -- [AppCategory](../interfaces/client._internal_namespace.AppCategory.md) -- [AttachedToCaseArgs](../interfaces/client._internal_namespace.AttachedToCaseArgs.md) -- [Attributes](../interfaces/client._internal_namespace.Attributes.md) -- [AuditEvent](../interfaces/client._internal_namespace.AuditEvent.md) -- [AuditLogger](../interfaces/client._internal_namespace.AuditLogger.md) -- [AuthFilterHelpers](../interfaces/client._internal_namespace.AuthFilterHelpers.md) -- [AuthenticatedUser](../interfaces/client._internal_namespace.AuthenticatedUser.md) -- [AuthenticationProvider](../interfaces/client._internal_namespace.AuthenticationProvider.md) -- [AuthorizationMode](../interfaces/client._internal_namespace.AuthorizationMode-1.md) -- [AuthorizationServiceSetup](../interfaces/client._internal_namespace.AuthorizationServiceSetup.md) -- [BeforeSaveContext](../interfaces/client._internal_namespace.BeforeSaveContext.md) -- [BuilderParameters](../interfaces/client._internal_namespace.BuilderParameters.md) -- [BuilderReturnValue](../interfaces/client._internal_namespace.BuilderReturnValue.md) -- [BulkCreateAttachmentDeletionUserAction](../interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md) -- [BulkCreateBulkUpdateCaseUserActions](../interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md) -- [BulkCreateCaseDeletionUserAction](../interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md) -- [BulkUpdateAttachmentArgs](../interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md) -- [CancellableTask](../interfaces/client._internal_namespace.CancellableTask.md) -- [Capabilities](../interfaces/client._internal_namespace.Capabilities.md) -- [CaseCommentStats](../interfaces/client._internal_namespace.CaseCommentStats.md) -- [CasesClientArgs](../interfaces/client._internal_namespace.CasesClientArgs.md) -- [CasesMapWithPageInfo](../interfaces/client._internal_namespace.CasesMapWithPageInfo.md) -- [CheckPrivileges](../interfaces/client._internal_namespace.CheckPrivileges.md) -- [CheckPrivilegesOptions](../interfaces/client._internal_namespace.CheckPrivilegesOptions.md) -- [CheckPrivilegesPayload](../interfaces/client._internal_namespace.CheckPrivilegesPayload.md) -- [CheckPrivilegesResponse](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md) -- [ClientArgs](../interfaces/client._internal_namespace.ClientArgs.md) -- [ClientArgs](../interfaces/client._internal_namespace.ClientArgs-1.md) -- [ClientArgs](../interfaces/client._internal_namespace.ClientArgs-2.md) -- [CommonArguments](../interfaces/client._internal_namespace.CommonArguments.md) -- [ConcreteTaskInstance](../interfaces/client._internal_namespace.ConcreteTaskInstance.md) -- [ConnectorToken](../interfaces/client._internal_namespace.ConnectorToken.md) -- [ConstructorOptions](../interfaces/client._internal_namespace.ConstructorOptions.md) -- [ConstructorOptions](../interfaces/client._internal_namespace.ConstructorOptions-1.md) -- [ConstructorOptions](../interfaces/client._internal_namespace.ConstructorOptions-2.md) -- [CountActionsAttachedToCaseArgs](../interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md) -- [CreateAttachmentArgs](../interfaces/client._internal_namespace.CreateAttachmentArgs.md) -- [CreateAuditMsgParams](../interfaces/client._internal_namespace.CreateAuditMsgParams.md) -- [CreateOptions](../interfaces/client._internal_namespace.CreateOptions.md) -- [CreateOptions](../interfaces/client._internal_namespace.CreateOptions-1.md) -- [CreateUserAction](../interfaces/client._internal_namespace.CreateUserAction.md) -- [CreateUserActionES](../interfaces/client._internal_namespace.CreateUserActionES.md) -- [DecoratedError](../interfaces/client._internal_namespace.DecoratedError.md) -- [ElasticsearchFeatureConfig](../interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md) -- [EmbeddableRegistryDefinition](../interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md) -- [EncryptedSavedObjectsClient](../interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md) -- [ExecuteOptions](../interfaces/client._internal_namespace.ExecuteOptions.md) -- [ExecuteOptions](../interfaces/client._internal_namespace.ExecuteOptions-1.md) -- [FeatureElasticsearchPrivileges](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md) -- [FeatureKibanaPrivileges](../interfaces/client._internal_namespace.FeatureKibanaPrivileges.md) -- [FeatureUsageServiceSetup](../interfaces/client._internal_namespace.FeatureUsageServiceSetup.md) -- [FindActionResult](../interfaces/client._internal_namespace.FindActionResult.md) -- [FindCaseCommentsArgs](../interfaces/client._internal_namespace.FindCaseCommentsArgs.md) -- [FindCaseConfigureArgs](../interfaces/client._internal_namespace.FindCaseConfigureArgs.md) -- [FindCasesArgs](../interfaces/client._internal_namespace.FindCasesArgs.md) -- [FindCommentsArgs](../interfaces/client._internal_namespace.FindCommentsArgs.md) -- [FindConnectorMappingsArgs](../interfaces/client._internal_namespace.FindConnectorMappingsArgs.md) -- [GetAllSpacesOptions](../interfaces/client._internal_namespace.GetAllSpacesOptions.md) -- [GetAttachmentArgs](../interfaces/client._internal_namespace.GetAttachmentArgs.md) -- [GetCaseArgs](../interfaces/client._internal_namespace.GetCaseArgs.md) -- [GetCaseConfigureArgs](../interfaces/client._internal_namespace.GetCaseConfigureArgs.md) -- [GetCaseIdsByAlertIdArgs](../interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md) -- [GetCaseUserActionArgs](../interfaces/client._internal_namespace.GetCaseUserActionArgs.md) -- [GetCasesArgs](../interfaces/client._internal_namespace.GetCasesArgs.md) -- [GetReportersArgs](../interfaces/client._internal_namespace.GetReportersArgs.md) -- [GetSpaceResult](../interfaces/client._internal_namespace.GetSpaceResult.md) -- [GetTagsArgs](../interfaces/client._internal_namespace.GetTagsArgs.md) -- [GetUserActionItemByDifference](../interfaces/client._internal_namespace.GetUserActionItemByDifference.md) -- [GetUserArgs](../interfaces/client._internal_namespace.GetUserArgs.md) -- [IEventLogger](../interfaces/client._internal_namespace.IEventLogger.md) -- [IKibanaSocket](../interfaces/client._internal_namespace.IKibanaSocket.md) -- [ILicense](../interfaces/client._internal_namespace.ILicense.md) -- [ISavedObjectsPointInTimeFinder](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md) -- [IScopedClusterClient](../interfaces/client._internal_namespace.IScopedClusterClient.md) -- [ISpacesClient](../interfaces/client._internal_namespace.ISpacesClient.md) -- [IUsageCounter](../interfaces/client._internal_namespace.IUsageCounter.md) -- [IncrementCounterParams](../interfaces/client._internal_namespace.IncrementCounterParams.md) -- [IndexMapping](../interfaces/client._internal_namespace.IndexMapping.md) -- [IndexMappingMeta](../interfaces/client._internal_namespace.IndexMappingMeta.md) -- [IntervalSchedule](../interfaces/client._internal_namespace.IntervalSchedule.md) -- [KibanaFeatureConfig](../interfaces/client._internal_namespace.KibanaFeatureConfig.md) -- [KibanaMigratorOptions](../interfaces/client._internal_namespace.KibanaMigratorOptions.md) -- [KibanaMigratorStatus](../interfaces/client._internal_namespace.KibanaMigratorStatus.md) -- [KibanaRequestEvents](../interfaces/client._internal_namespace.KibanaRequestEvents.md) -- [LegacyUrlAliasTarget](../interfaces/client._internal_namespace.LegacyUrlAliasTarget.md) -- [LicenseCheck](../interfaces/client._internal_namespace.LicenseCheck.md) -- [LicenseFeature](../interfaces/client._internal_namespace.LicenseFeature.md) -- [LicensingPluginSetup](../interfaces/client._internal_namespace.LicensingPluginSetup.md) -- [Middleware](../interfaces/client._internal_namespace.Middleware.md) -- [OperationDetails](../interfaces/client._internal_namespace.OperationDetails.md) -- [OwnerEntity](../interfaces/client._internal_namespace.OwnerEntity.md) -- [PatchCase](../interfaces/client._internal_namespace.PatchCase.md) -- [PatchCaseConfigureArgs](../interfaces/client._internal_namespace.PatchCaseConfigureArgs.md) -- [PatchCasesArgs](../interfaces/client._internal_namespace.PatchCasesArgs.md) -- [PersistableState](../interfaces/client._internal_namespace.PersistableState.md) -- [PluginStartContract](../interfaces/client._internal_namespace.PluginStartContract.md) -- [PostCaseArgs](../interfaces/client._internal_namespace.PostCaseArgs.md) -- [PostCaseConfigureArgs](../interfaces/client._internal_namespace.PostCaseConfigureArgs.md) -- [PostCaseUserActionArgs](../interfaces/client._internal_namespace.PostCaseUserActionArgs.md) -- [PostConnectorMappingsArgs](../interfaces/client._internal_namespace.PostConnectorMappingsArgs.md) -- [PreConfiguredAction](../interfaces/client._internal_namespace.PreConfiguredAction.md) -- [ProxySettings](../interfaces/client._internal_namespace.ProxySettings.md) -- [PublicLicense](../interfaces/client._internal_namespace.PublicLicense.md) -- [PublicLicenseJSON](../interfaces/client._internal_namespace.PublicLicenseJSON.md) -- [PushedArgs](../interfaces/client._internal_namespace.PushedArgs.md) -- [Referencable](../interfaces/client._internal_namespace.Referencable.md) -- [ReservedKibanaPrivilege](../interfaces/client._internal_namespace.ReservedKibanaPrivilege.md) -- [ResponseSettings](../interfaces/client._internal_namespace.ResponseSettings.md) -- [RouteConfigOptions](../interfaces/client._internal_namespace.RouteConfigOptions.md) -- [RouteConfigOptionsBody](../interfaces/client._internal_namespace.RouteConfigOptionsBody.md) -- [RouteValidationResultFactory](../interfaces/client._internal_namespace.RouteValidationResultFactory.md) -- [RouteValidatorConfig](../interfaces/client._internal_namespace.RouteValidatorConfig.md) -- [RouteValidatorOptions](../interfaces/client._internal_namespace.RouteValidatorOptions.md) -- [RunContext](../interfaces/client._internal_namespace.RunContext.md) -- [RunNowResult](../interfaces/client._internal_namespace.RunNowResult.md) -- [SSLSettings](../interfaces/client._internal_namespace.SSLSettings.md) -- [SavedObject](../interfaces/client._internal_namespace.SavedObject.md) -- [SavedObjectAttributes](../interfaces/client._internal_namespace.SavedObjectAttributes.md) -- [SavedObjectDoc](../interfaces/client._internal_namespace.SavedObjectDoc.md) -- [SavedObjectError](../interfaces/client._internal_namespace.SavedObjectError.md) -- [SavedObjectMigrationContext](../interfaces/client._internal_namespace.SavedObjectMigrationContext.md) -- [SavedObjectMigrationMap](../interfaces/client._internal_namespace.SavedObjectMigrationMap.md) -- [SavedObjectReference](../interfaces/client._internal_namespace.SavedObjectReference.md) -- [SavedObjectReferenceWithContext](../interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md) -- [SavedObjectsBaseOptions](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) -- [SavedObjectsBulkCreateObject](../interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md) -- [SavedObjectsBulkGetObject](../interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md) -- [SavedObjectsBulkResolveObject](../interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md) -- [SavedObjectsBulkResolveResponse](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md) -- [SavedObjectsBulkResponse](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md) -- [SavedObjectsBulkUpdateObject](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md) -- [SavedObjectsBulkUpdateOptions](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md) -- [SavedObjectsBulkUpdateResponse](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md) -- [SavedObjectsCheckConflictsObject](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md) -- [SavedObjectsCheckConflictsResponse](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md) -- [SavedObjectsClosePointInTimeResponse](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md) -- [SavedObjectsCollectMultiNamespaceReferencesObject](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md) -- [SavedObjectsCollectMultiNamespaceReferencesOptions](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md) -- [SavedObjectsCollectMultiNamespaceReferencesResponse](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md) -- [SavedObjectsCreateOptions](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) -- [SavedObjectsCreatePointInTimeFinderDependencies](../interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md) -- [SavedObjectsDeleteByNamespaceOptions](../interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md) -- [SavedObjectsDeleteOptions](../interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md) -- [SavedObjectsExportTransformContext](../interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md) -- [SavedObjectsFindOptions](../interfaces/client._internal_namespace.SavedObjectsFindOptions.md) -- [SavedObjectsFindOptionsReference](../interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md) -- [SavedObjectsFindResponse](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md) -- [SavedObjectsFindResult](../interfaces/client._internal_namespace.SavedObjectsFindResult.md) -- [SavedObjectsImportActionRequiredWarning](../interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md) -- [SavedObjectsImportHookResult](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md) -- [SavedObjectsImportSimpleWarning](../interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md) -- [SavedObjectsIncrementCounterField](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md) -- [SavedObjectsIncrementCounterOptions](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md) -- [SavedObjectsMappingProperties](../interfaces/client._internal_namespace.SavedObjectsMappingProperties.md) -- [SavedObjectsMigrationLogger](../interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md) -- [SavedObjectsMigrationVersion](../interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md) -- [SavedObjectsOpenPointInTimeOptions](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md) -- [SavedObjectsOpenPointInTimeResponse](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md) -- [SavedObjectsPitParams](../interfaces/client._internal_namespace.SavedObjectsPitParams.md) -- [SavedObjectsRemoveReferencesToOptions](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md) -- [SavedObjectsRemoveReferencesToResponse](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md) -- [SavedObjectsResolveResponse](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md) -- [SavedObjectsType](../interfaces/client._internal_namespace.SavedObjectsType.md) -- [SavedObjectsTypeManagementDefinition](../interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md) -- [SavedObjectsTypeMappingDefinition](../interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md) -- [SavedObjectsUpdateObjectsSpacesObject](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md) -- [SavedObjectsUpdateObjectsSpacesOptions](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md) -- [SavedObjectsUpdateObjectsSpacesResponse](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md) -- [SavedObjectsUpdateObjectsSpacesResponseObject](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md) -- [SavedObjectsUpdateOptions](../interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md) -- [SavedObjectsUpdateResponse](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md) -- [SavedObjectsValidationMap](../interfaces/client._internal_namespace.SavedObjectsValidationMap.md) -- [Services](../interfaces/client._internal_namespace.Services.md) -- [Space](../interfaces/client._internal_namespace.Space.md) -- [SpacesServiceStart](../interfaces/client._internal_namespace.SpacesServiceStart.md) -- [SubFeatureConfig](../interfaces/client._internal_namespace.SubFeatureConfig.md) -- [SubFeaturePrivilegeConfig](../interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md) -- [SubFeaturePrivilegeGroupConfig](../interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md) -- [TaskInfo](../interfaces/client._internal_namespace.TaskInfo.md) -- [TaskInstance](../interfaces/client._internal_namespace.TaskInstance.md) -- [TaskManagerSetupContract](../interfaces/client._internal_namespace.TaskManagerSetupContract.md) -- [TaskRegisterDefinition](../interfaces/client._internal_namespace.TaskRegisterDefinition.md) -- [TaskRunnerContext](../interfaces/client._internal_namespace.TaskRunnerContext.md) -- [TranslatedUpdateAlertRequest](../interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md) -- [UpdateAlertRequest](../interfaces/client._internal_namespace.UpdateAlertRequest.md) -- [UpdateArgs](../interfaces/client._internal_namespace.UpdateArgs.md) -- [UpdateConnectorMappingsArgs](../interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md) -- [UpdateOptions](../interfaces/client._internal_namespace.UpdateOptions.md) -- [UpdateOptions](../interfaces/client._internal_namespace.UpdateOptions-1.md) -- [User](../interfaces/client._internal_namespace.User.md) -- [UserRealm](../interfaces/client._internal_namespace.UserRealm.md) -- [ValidatorType](../interfaces/client._internal_namespace.ValidatorType.md) -- [Verbs](../interfaces/client._internal_namespace.Verbs.md) - -### Type aliases - -- [ActionExecutorContract](client._internal_namespace.md#actionexecutorcontract) -- [ActionTypeConfig](client._internal_namespace.md#actiontypeconfig) -- [ActionTypeParams](client._internal_namespace.md#actiontypeparams) -- [ActionTypeRegistryContract](client._internal_namespace.md#actiontyperegistrycontract) -- [ActionTypeSecrets](client._internal_namespace.md#actiontypesecrets) -- [ActionsClient](client._internal_namespace.md#actionsclient) -- [AggregationResponse](client._internal_namespace.md#aggregationresponse) -- [BeforeRunContextFunction](client._internal_namespace.md#beforeruncontextfunction) -- [BeforeSaveContextFunction](client._internal_namespace.md#beforesavecontextfunction) -- [CancelFunction](client._internal_namespace.md#cancelfunction) -- [CasesFindRequest](client._internal_namespace.md#casesfindrequest) -- [CheckPrivilegesDynamically](client._internal_namespace.md#checkprivilegesdynamically) -- [CheckPrivilegesDynamicallyWithRequest](client._internal_namespace.md#checkprivilegesdynamicallywithrequest) -- [CheckPrivilegesWithRequest](client._internal_namespace.md#checkprivilegeswithrequest) -- [CheckSavedObjectsPrivileges](client._internal_namespace.md#checksavedobjectsprivileges) -- [CheckSavedObjectsPrivilegesWithRequest](client._internal_namespace.md#checksavedobjectsprivilegeswithrequest) -- [CommonBuilderArguments](client._internal_namespace.md#commonbuilderarguments) -- [CommonUserActionArgs](client._internal_namespace.md#commonuseractionargs) -- [ConnectorTokenClientContract](client._internal_namespace.md#connectortokenclientcontract) -- [CreateUserActionClient](client._internal_namespace.md#createuseractionclient) -- [DeepPartial](client._internal_namespace.md#deeppartial) -- [DeepWriteable](client._internal_namespace.md#deepwriteable) -- [DestructiveRouteMethod](client._internal_namespace.md#destructiveroutemethod) -- [ElasticsearchClient](client._internal_namespace.md#elasticsearchclient) -- [EmbeddableInput](client._internal_namespace.md#embeddableinput) -- [EmbeddableStateWithType](client._internal_namespace.md#embeddablestatewithtype) -- [EnsureSOAuthCallback](client._internal_namespace.md#ensuresoauthcallback) -- [ExecutionEnqueuer](client._internal_namespace.md#executionenqueuer) -- [ExecutorType](client._internal_namespace.md#executortype) -- [FailedRunResult](client._internal_namespace.md#failedrunresult) -- [FindCaseOptions](client._internal_namespace.md#findcaseoptions) -- [GetAllSpacesPurpose](client._internal_namespace.md#getallspacespurpose) -- [GetMigrationFunctionObjectFn](client._internal_namespace.md#getmigrationfunctionobjectfn) -- [GetServicesFunction](client._internal_namespace.md#getservicesfunction) -- [GetSpaceFn](client._internal_namespace.md#getspacefn) -- [Headers](client._internal_namespace.md#headers) -- [IBasePath](client._internal_namespace.md#ibasepath) -- [IEvent](client._internal_namespace.md#ievent) -- [IKibanaMigrator](client._internal_namespace.md#ikibanamigrator) -- [ILicenseState](client._internal_namespace.md#ilicensestate) -- [ISavedObjectTypeRegistry](client._internal_namespace.md#isavedobjecttyperegistry) -- [ISavedObjectsRepository](client._internal_namespace.md#isavedobjectsrepository) -- [IValidatedEvent](client._internal_namespace.md#ivalidatedevent) -- [KibanaExecutionContext](client._internal_namespace.md#kibanaexecutioncontext) -- [KibanaRequestRouteOptions](client._internal_namespace.md#kibanarequestrouteoptions) -- [KnownHeaders](client._internal_namespace.md#knownheaders) -- [KnownKeys](client._internal_namespace.md#knownkeys) -- [LicenseCheckState](client._internal_namespace.md#licensecheckstate) -- [LicenseStatus](client._internal_namespace.md#licensestatus) -- [Mapper](client._internal_namespace.md#mapper) -- [MigrateFunction](client._internal_namespace.md#migratefunction) -- [MigrateFunctionsObject](client._internal_namespace.md#migratefunctionsobject) -- [MigrationResult](client._internal_namespace.md#migrationresult) -- [MigrationStatus](client._internal_namespace.md#migrationstatus) -- [MutatingOperationRefreshSetting](client._internal_namespace.md#mutatingoperationrefreshsetting) -- [PatchCaseArgs](client._internal_namespace.md#patchcaseargs) -- [PersistableStateDefinition](client._internal_namespace.md#persistablestatedefinition) -- [PublicFeatures](client._internal_namespace.md#publicfeatures) -- [RouteContentType](client._internal_namespace.md#routecontenttype) -- [RouteMethod](client._internal_namespace.md#routemethod) -- [RouteValidationFunction](client._internal_namespace.md#routevalidationfunction) -- [RouteValidationSpec](client._internal_namespace.md#routevalidationspec) -- [RouteValidatorFullConfig](client._internal_namespace.md#routevalidatorfullconfig) -- [RunFunction](client._internal_namespace.md#runfunction) -- [RunResult](client._internal_namespace.md#runresult) -- [SafeRouteMethod](client._internal_namespace.md#saferoutemethod) -- [SavedObjectAttribute](client._internal_namespace.md#savedobjectattribute) -- [SavedObjectAttributeSingle](client._internal_namespace.md#savedobjectattributesingle) -- [SavedObjectFindOptions](client._internal_namespace.md#savedobjectfindoptions) -- [SavedObjectFindOptionsKueryNode](client._internal_namespace.md#savedobjectfindoptionskuerynode) -- [SavedObjectMigrationFn](client._internal_namespace.md#savedobjectmigrationfn) -- [SavedObjectTypeExcludeFromUpgradeFilterHook](client._internal_namespace.md#savedobjecttypeexcludefromupgradefilterhook) -- [SavedObjectUnsanitizedDoc](client._internal_namespace.md#savedobjectunsanitizeddoc) -- [SavedObjectsClientContract](client._internal_namespace.md#savedobjectsclientcontract) -- [SavedObjectsCreatePointInTimeFinderOptions](client._internal_namespace.md#savedobjectscreatepointintimefinderoptions) -- [SavedObjectsExportTransform](client._internal_namespace.md#savedobjectsexporttransform) -- [SavedObjectsExportablePredicate](client._internal_namespace.md#savedobjectsexportablepredicate) -- [SavedObjectsFieldMapping](client._internal_namespace.md#savedobjectsfieldmapping) -- [SavedObjectsImportHook](client._internal_namespace.md#savedobjectsimporthook) -- [SavedObjectsImportWarning](client._internal_namespace.md#savedobjectsimportwarning) -- [SavedObjectsNamespaceType](client._internal_namespace.md#savedobjectsnamespacetype) -- [SavedObjectsValidationSpec](client._internal_namespace.md#savedobjectsvalidationspec) -- [SpaceIdToNamespaceFunction](client._internal_namespace.md#spaceidtonamespacefunction) -- [StringKeysAsVals](client._internal_namespace.md#stringkeysasvals) -- [SubFeaturePrivilegeGroupType](client._internal_namespace.md#subfeatureprivilegegrouptype) -- [SuccessfulRunResult](client._internal_namespace.md#successfulrunresult) -- [TaskDefinitionRegistry](client._internal_namespace.md#taskdefinitionregistry) -- [TaskRunCreatorFunction](client._internal_namespace.md#taskruncreatorfunction) -- [UpdateAttachmentArgs](client._internal_namespace.md#updateattachmentargs) -- [UserAction](client._internal_namespace.md#useraction) -- [UserActionParameters](client._internal_namespace.md#useractionparameters) -- [UserActionTypes](client._internal_namespace.md#useractiontypes) - -### Variables - -- [ActionTypesRt](client._internal_namespace.md#actiontypesrt) -- [ActionsRt](client._internal_namespace.md#actionsrt) -- [CasesFindRequestRt](client._internal_namespace.md#casesfindrequestrt) -- [EventSchema](client._internal_namespace.md#eventschema) -- [SavedObjectFindOptionsRt](client._internal_namespace.md#savedobjectfindoptionsrt) - -## Enumeration members - -### actions - -• **actions**: `Object` = `"actions"` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/comment.ts:26](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L26) - -___ - -### alert - -• **alert**: `Object` = `"alert"` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/comment.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L25) - -___ - -### jira - -• **jira**: `Object` = `".jira"` - -#### Defined in - -[x-pack/plugins/cases/common/api/connectors/index.ts:36](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L36) - -___ - -### none - -• **none**: `Object` = `".none"` - -#### Defined in - -[x-pack/plugins/cases/common/api/connectors/index.ts:37](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L37) - -___ - -### resilient - -• **resilient**: `Object` = `".resilient"` - -#### Defined in - -[x-pack/plugins/cases/common/api/connectors/index.ts:38](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L38) - -___ - -### serviceNowITSM - -• **serviceNowITSM**: `Object` = `".servicenow"` - -#### Defined in - -[x-pack/plugins/cases/common/api/connectors/index.ts:39](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L39) - -___ - -### serviceNowSIR - -• **serviceNowSIR**: `Object` = `".servicenow-sir"` - -#### Defined in - -[x-pack/plugins/cases/common/api/connectors/index.ts:40](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L40) - -___ - -### swimlane - -• **swimlane**: `Object` = `".swimlane"` - -#### Defined in - -[x-pack/plugins/cases/common/api/connectors/index.ts:41](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L41) - -___ - -### user - -• **user**: `Object` = `"user"` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/comment.ts:24](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L24) - -## Type aliases - -### ActionExecutorContract - -Ƭ **ActionExecutorContract**: `PublicMethodsOf`<[`ActionExecutor`](../classes/client._internal_namespace.ActionExecutor.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:34 - -___ - -### ActionTypeConfig - -Ƭ **ActionTypeConfig**: `Record`<`string`, `unknown`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:19 - -___ - -### ActionTypeParams - -Ƭ **ActionTypeParams**: `Record`<`string`, `unknown`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:21 - -___ - -### ActionTypeRegistryContract - -Ƭ **ActionTypeRegistryContract**: `PublicMethodsOf`<[`ActionTypeRegistry`](../classes/client._internal_namespace.ActionTypeRegistry.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:17 - -___ - -### ActionTypeSecrets - -Ƭ **ActionTypeSecrets**: `Record`<`string`, `unknown`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:20 - -___ - -### ActionsClient - -Ƭ **ActionsClient**: `PublicMethodsOf`<[`ActionsClient`](../classes/client._internal_namespace.ActionsClient.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/index.d.ts:7 - -___ - -### AggregationResponse - -Ƭ **AggregationResponse**: `Record`<`string`, `estypes.AggregationsAggregate`\> \| `undefined` - -#### Defined in - -[x-pack/plugins/cases/server/client/metrics/types.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/types.ts#L25) - -___ - -### BeforeRunContextFunction - -Ƭ **BeforeRunContextFunction**: [`Mapper`](client._internal_namespace.md#mapper)<[`RunContext`](../interfaces/client._internal_namespace.RunContext.md)\> - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:7 - -___ - -### BeforeSaveContextFunction - -Ƭ **BeforeSaveContextFunction**: [`Mapper`](client._internal_namespace.md#mapper)<[`BeforeSaveContext`](../interfaces/client._internal_namespace.BeforeSaveContext.md)\> - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:6 - -___ - -### CancelFunction - -Ƭ **CancelFunction**: () => `Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> - -#### Type declaration - -▸ (): `Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> - -##### Returns - -`Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:65 - -___ - -### CasesFindRequest - -Ƭ **CasesFindRequest**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:284](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L284) - -___ - -### CheckPrivilegesDynamically - -Ƭ **CheckPrivilegesDynamically**: (`privileges`: [`CheckPrivilegesPayload`](../interfaces/client._internal_namespace.CheckPrivilegesPayload.md), `options?`: [`CheckPrivilegesOptions`](../interfaces/client._internal_namespace.CheckPrivilegesOptions.md)) => `Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Type declaration - -▸ (`privileges`, `options?`): `Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `privileges` | [`CheckPrivilegesPayload`](../interfaces/client._internal_namespace.CheckPrivilegesPayload.md) | -| `options?` | [`CheckPrivilegesOptions`](../interfaces/client._internal_namespace.CheckPrivilegesOptions.md) | - -##### Returns - -`Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/check_privileges_dynamically.d.ts:4 - -___ - -### CheckPrivilegesDynamicallyWithRequest - -Ƭ **CheckPrivilegesDynamicallyWithRequest**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => [`CheckPrivilegesDynamically`](client._internal_namespace.md#checkprivilegesdynamically) - -#### Type declaration - -▸ (`request`): [`CheckPrivilegesDynamically`](client._internal_namespace.md#checkprivilegesdynamically) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | - -##### Returns - -[`CheckPrivilegesDynamically`](client._internal_namespace.md#checkprivilegesdynamically) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/check_privileges_dynamically.d.ts:5 - -___ - -### CheckPrivilegesWithRequest - -Ƭ **CheckPrivilegesWithRequest**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => [`CheckPrivileges`](../interfaces/client._internal_namespace.CheckPrivileges.md) - -#### Type declaration - -▸ (`request`): [`CheckPrivileges`](../interfaces/client._internal_namespace.CheckPrivileges.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | - -##### Returns - -[`CheckPrivileges`](../interfaces/client._internal_namespace.CheckPrivileges.md) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/types.d.ts:59 - -___ - -### CheckSavedObjectsPrivileges - -Ƭ **CheckSavedObjectsPrivileges**: (`actions`: `string` \| `string`[], `namespaceOrNamespaces?`: `string` \| (`undefined` \| `string`)[]) => `Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Type declaration - -▸ (`actions`, `namespaceOrNamespaces?`): `Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `actions` | `string` \| `string`[] | -| `namespaceOrNamespaces?` | `string` \| (`undefined` \| `string`)[] | - -##### Returns - -`Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/check_saved_objects_privileges.d.ts:5 - -___ - -### CheckSavedObjectsPrivilegesWithRequest - -Ƭ **CheckSavedObjectsPrivilegesWithRequest**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => [`CheckSavedObjectsPrivileges`](client._internal_namespace.md#checksavedobjectsprivileges) - -#### Type declaration - -▸ (`request`): [`CheckSavedObjectsPrivileges`](client._internal_namespace.md#checksavedobjectsprivileges) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | - -##### Returns - -[`CheckSavedObjectsPrivileges`](client._internal_namespace.md#checksavedobjectsprivileges) - -#### Defined in - -x-pack/plugins/security/target/types/server/authorization/check_saved_objects_privileges.d.ts:4 - -___ - -### CommonBuilderArguments - -Ƭ **CommonBuilderArguments**: [`CommonArguments`](../interfaces/client._internal_namespace.CommonArguments.md) & { `action`: [`UserAction`](client._internal_namespace.md#useraction) ; `type`: [`UserActionTypes`](client._internal_namespace.md#useractiontypes) ; `value`: `unknown` ; `valueKey`: `string` } - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:97](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L97) - -___ - -### CommonUserActionArgs - -Ƭ **CommonUserActionArgs**: [`ClientArgs`](../interfaces/client._internal_namespace.ClientArgs-1.md) & [`CommonArguments`](../interfaces/client._internal_namespace.CommonArguments.md) - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L75) - -___ - -### ConnectorTokenClientContract - -Ƭ **ConnectorTokenClientContract**: `PublicMethodsOf`<[`ConnectorTokenClient`](../classes/client._internal_namespace.ConnectorTokenClient.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:22 - -___ - -### CreateUserActionClient - -Ƭ **CreateUserActionClient**<`T`\>: [`CreateUserAction`](../interfaces/client._internal_namespace.CreateUserAction.md)<`T`\> & [`CommonUserActionArgs`](client._internal_namespace.md#commonuseractionargs) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends keyof [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md) | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/index.ts:98](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L98) - -___ - -### DeepPartial - -Ƭ **DeepPartial**<`T`\>: { [P in keyof T]?: T[P] extends infer U[] ? DeepPartial[] : DeepPartial } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -x-pack/plugins/event_log/target/types/generated/schemas.d.ts:5 - -___ - -### DeepWriteable - -Ƭ **DeepWriteable**<`T`\>: { -readonly [P in keyof T]: DeepWriteable } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -x-pack/plugins/event_log/target/types/generated/schemas.d.ts:2 - -___ - -### DestructiveRouteMethod - -Ƭ **DestructiveRouteMethod**: ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` - -Set of HTTP methods changing the state of the server. - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:7 - -___ - -### ElasticsearchClient - -Ƭ **ElasticsearchClient**: `Omit`<`KibanaClient`, ``"connectionPool"`` \| ``"transport"`` \| ``"serializer"`` \| ``"extend"`` \| ``"child"`` \| ``"close"`` \| ``"diagnostic"``\> & { `transport`: { `request`: (`params`: `TransportRequestParams`, `options?`: `TransportRequestOptions`) => `Promise`<`TransportResult`<`TResponse`, `unknown`\>\> } } - -Client used to query the elasticsearch cluster. - -#### Defined in - -src/core/target/types/server/elasticsearch/client/types.d.ts:8 - -___ - -### EmbeddableInput - -Ƭ **EmbeddableInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `disableTriggers?` | `boolean` | Whether this embeddable should not execute triggers. | -| `disabledActions?` | `string`[] | List of action IDs that this embeddable should not render. | -| `enhancements?` | `SerializableRecord` | Reserved key for enhancements added by other plugins. | -| `executionContext?` | [`KibanaExecutionContext`](client._internal_namespace.md#kibanaexecutioncontext) | - | -| `hidePanelTitles?` | `boolean` | - | -| `id` | `string` | Note this is not a saved object id. It is used to uniquely identify this Embeddable instance from others (e.g. inside a container). It's possible to have two Embeddables where everything else is the same but the id. | -| `lastReloadRequestTime?` | `number` | - | -| `searchSessionId?` | `string` | Search session id to group searches | -| `syncColors?` | `boolean` | Flag whether colors should be synced with other panels | -| `title?` | `string` | - | -| `viewMode?` | [`ViewMode`](../enums/client._internal_namespace.ViewMode.md) | - | - -#### Defined in - -src/plugins/embeddable/target/types/common/types.d.ts:10 - -___ - -### EmbeddableStateWithType - -Ƭ **EmbeddableStateWithType**: [`EmbeddableInput`](client._internal_namespace.md#embeddableinput) & { `type`: `string` } - -#### Defined in - -src/plugins/embeddable/target/types/common/types.d.ts:53 - -___ - -### EnsureSOAuthCallback - -Ƭ **EnsureSOAuthCallback**: (`entities`: [`OwnerEntity`](../interfaces/client._internal_namespace.OwnerEntity.md)[]) => `void` - -#### Type declaration - -▸ (`entities`): `void` - -Function callback for making sure the found saved objects are of the authorized owner - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `entities` | [`OwnerEntity`](../interfaces/client._internal_namespace.OwnerEntity.md)[] | - -##### Returns - -`void` - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:110](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L110) - -___ - -### ExecutionEnqueuer - -Ƭ **ExecutionEnqueuer**<`T`\>: (`unsecuredSavedObjectsClient`: [`SavedObjectsClientContract`](client._internal_namespace.md#savedobjectsclientcontract), `options`: [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions-1.md)) => `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Type declaration - -▸ (`unsecuredSavedObjectsClient`, `options`): `Promise`<`T`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](client._internal_namespace.md#savedobjectsclientcontract) | -| `options` | [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions-1.md) | - -##### Returns - -`Promise`<`T`\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:19 - -___ - -### ExecutorType - -Ƭ **ExecutorType**<`Config`, `Secrets`, `Params`, `ResultData`\>: (`options`: [`ActionTypeExecutorOptions`](../interfaces/client._internal_namespace.ActionTypeExecutorOptions.md)<`Config`, `Secrets`, `Params`\>) => `Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`ResultData`\>\> - -#### Type parameters - -| Name | -| :------ | -| `Config` | -| `Secrets` | -| `Params` | -| `ResultData` | - -#### Type declaration - -▸ (`options`): `Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`ResultData`\>\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`ActionTypeExecutorOptions`](../interfaces/client._internal_namespace.ActionTypeExecutorOptions.md)<`Config`, `Secrets`, `Params`\> | - -##### Returns - -`Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`ResultData`\>\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:62 - -___ - -### FailedRunResult - -Ƭ **FailedRunResult**: [`SuccessfulRunResult`](client._internal_namespace.md#successfulrunresult) & { `error`: `Error` } - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:52 - -___ - -### FindCaseOptions - -Ƭ **FindCaseOptions**: [`CasesFindRequest`](client._internal_namespace.md#casesfindrequest) & [`SavedObjectFindOptionsKueryNode`](client._internal_namespace.md#savedobjectfindoptionskuerynode) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:125](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L125) - -___ - -### GetAllSpacesPurpose - -Ƭ **GetAllSpacesPurpose**: ``"any"`` \| ``"copySavedObjectsIntoSpace"`` \| ``"findSavedObjects"`` \| ``"shareSavedObjectsIntoSpace"`` - -The set of purposes to retrieve spaces: -- `any`: retrieves all spaces the user is authorized to see. -- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into. -- `findSavedObjects`: retrieves all spaces the user is authorized to search within. -- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into. - -#### Defined in - -x-pack/plugins/spaces/target/types/common/types.d.ts:74 - -___ - -### GetMigrationFunctionObjectFn - -Ƭ **GetMigrationFunctionObjectFn**: () => [`MigrateFunctionsObject`](client._internal_namespace.md#migratefunctionsobject) - -#### Type declaration - -▸ (): [`MigrateFunctionsObject`](client._internal_namespace.md#migratefunctionsobject) - -##### Returns - -[`MigrateFunctionsObject`](client._internal_namespace.md#migratefunctionsobject) - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:77 - -___ - -### GetServicesFunction - -Ƭ **GetServicesFunction**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => [`Services`](../interfaces/client._internal_namespace.Services.md) - -#### Type declaration - -▸ (`request`): [`Services`](../interfaces/client._internal_namespace.Services.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | - -##### Returns - -[`Services`](../interfaces/client._internal_namespace.Services.md) - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:16 - -___ - -### GetSpaceFn - -Ƭ **GetSpaceFn**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => `Promise`<[`Space`](../interfaces/client._internal_namespace.Space.md) \| `undefined`\> - -#### Type declaration - -▸ (`request`): `Promise`<[`Space`](../interfaces/client._internal_namespace.Space.md) \| `undefined`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | - -##### Returns - -`Promise`<[`Space`](../interfaces/client._internal_namespace.Space.md) \| `undefined`\> - -#### Defined in - -[x-pack/plugins/cases/server/authorization/types.ts:21](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L21) - -___ - -### Headers - -Ƭ **Headers**: { [header in KnownHeaders]?: string \| string[] } & { [header: string]: `string` \| `string`[] \| `undefined`; } - -Http request headers to read. - -#### Defined in - -src/core/target/types/server/http/router/headers.d.ts:36 - -___ - -### IBasePath - -Ƭ **IBasePath**: `Pick`<[`BasePath`](../classes/client._internal_namespace.BasePath.md), keyof [`BasePath`](../classes/client._internal_namespace.BasePath.md)\> - -Access or manipulate the Kibana base path - -[BasePath](../classes/client._internal_namespace.BasePath.md) - -#### Defined in - -src/core/target/types/server/http/base_path_service.d.ts:50 - -___ - -### IEvent - -Ƭ **IEvent**: [`DeepPartial`](client._internal_namespace.md#deeppartial)<[`DeepWriteable`](client._internal_namespace.md#deepwriteable)<[`IValidatedEvent`](client._internal_namespace.md#ivalidatedevent)\>\> - -#### Defined in - -x-pack/plugins/event_log/target/types/generated/schemas.d.ts:10 - -___ - -### IKibanaMigrator - -Ƭ **IKibanaMigrator**: `Pick`<[`KibanaMigrator`](../classes/client._internal_namespace.KibanaMigrator.md), keyof [`KibanaMigrator`](../classes/client._internal_namespace.KibanaMigrator.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:17 - -___ - -### ILicenseState - -Ƭ **ILicenseState**: `PublicMethodsOf`<[`LicenseState`](../classes/client._internal_namespace.LicenseState.md)\> - -#### Defined in - -x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:6 - -___ - -### ISavedObjectTypeRegistry - -Ƭ **ISavedObjectTypeRegistry**: `Omit`<[`SavedObjectTypeRegistry`](../classes/client._internal_namespace.SavedObjectTypeRegistry.md), ``"registerType"``\> - -See [SavedObjectTypeRegistry](../classes/client._internal_namespace.SavedObjectTypeRegistry.md) for documentation. - -#### Defined in - -src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:7 - -___ - -### ISavedObjectsRepository - -Ƭ **ISavedObjectsRepository**: `Pick`<[`SavedObjectsRepository`](../classes/client._internal_namespace.SavedObjectsRepository.md), keyof [`SavedObjectsRepository`](../classes/client._internal_namespace.SavedObjectsRepository.md)\> - -See [SavedObjectsRepository](../classes/client._internal_namespace.SavedObjectsRepository.md) - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/repository.d.ts:57 - -___ - -### IValidatedEvent - -Ƭ **IValidatedEvent**: `TypeOf` - -#### Defined in - -x-pack/plugins/event_log/target/types/generated/schemas.d.ts:9 - -___ - -### KibanaExecutionContext - -Ƭ **KibanaExecutionContext**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `description` | `string` | human readable description. For example, a vis title, action name | -| `id` | `string` | unique value to identify the source | -| `name` | `string` | public name of a user-facing feature | -| `parent?` | [`KibanaExecutionContext`](client._internal_namespace.md#kibanaexecutioncontext) | a context that spawned the current context. | -| `type` | `string` | Kibana application initated an operation. | -| `url?` | `string` | in browser - url to navigate to a current page, on server - endpoint path, for task: task SO url | - -#### Defined in - -src/core/target/types/types/execution_context.d.ts:5 - -___ - -### KibanaRequestRouteOptions - -Ƭ **KibanaRequestRouteOptions**<`Method`\>: `Method` extends ``"get"`` \| ``"options"`` ? `Required`<`Omit`<[`RouteConfigOptions`](../interfaces/client._internal_namespace.RouteConfigOptions.md)<`Method`\>, ``"body"``\>\> : `Required`<[`RouteConfigOptions`](../interfaces/client._internal_namespace.RouteConfigOptions.md)<`Method`\>\> - -Route options: If 'GET' or 'OPTIONS' method, body options won't be returned. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Method` | extends [`RouteMethod`](client._internal_namespace.md#routemethod) | - -#### Defined in - -src/core/target/types/server/http/router/request.d.ts:30 - -___ - -### KnownHeaders - -Ƭ **KnownHeaders**: [`KnownKeys`](client._internal_namespace.md#knownkeys)<`IncomingHttpHeaders`\> - -Set of well-known HTTP headers. - -#### Defined in - -src/core/target/types/server/http/router/headers.d.ts:31 - -___ - -### KnownKeys - -Ƭ **KnownKeys**<`T`\>: [`StringKeysAsVals`](client._internal_namespace.md#stringkeysasvals)<`T`\> extends { [\_ in keyof T]: infer U } ? `U` : `never` - -Creates a Union type of all known keys of a given interface. - -**`example`** -```ts -interface Person { - name: string; - age: number; - [attributes: string]: string | number; -} -type PersonKnownKeys = KnownKeys; // "age" | "name" -``` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -src/core/target/types/server/http/router/headers.d.ts:24 - -___ - -### LicenseCheckState - -Ƭ **LicenseCheckState**: ``"unavailable"`` \| ``"invalid"`` \| ``"valid"`` \| ``"expired"`` - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:1 - -___ - -### LicenseStatus - -Ƭ **LicenseStatus**: ``"active"`` \| ``"invalid"`` \| ``"expired"`` - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:13 - -___ - -### Mapper - -Ƭ **Mapper**<`T`\>: (`params`: `T`) => `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Type declaration - -▸ (`params`): `Promise`<`T`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `T` | - -##### Returns - -`Promise`<`T`\> - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:2 - -___ - -### MigrateFunction - -Ƭ **MigrateFunction**<`FromVersion`, `ToVersion`\>: (`state`: `FromVersion`) => `ToVersion` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `FromVersion` | extends `Serializable` = `SerializableRecord` | -| `ToVersion` | extends `Serializable` = `SerializableRecord` | - -#### Type declaration - -▸ (`state`): `ToVersion` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `state` | `FromVersion` | - -##### Returns - -`ToVersion` - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:86 - -___ - -### MigrateFunctionsObject - -Ƭ **MigrateFunctionsObject**: `Object` - -Collection of migrations that a given type of persistable state object has -accumulated over time. Migration functions are keyed using semver version -of Kibana releases. - -#### Index signature - -▪ [semver: `string`]: [`MigrateFunction`](client._internal_namespace.md#migratefunction)<`any`, `any`\> - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:83 - -___ - -### MigrationResult - -Ƭ **MigrationResult**: { `status`: ``"skipped"`` } \| { `status`: ``"patched"`` } \| { `destIndex`: `string` ; `elapsedMs`: `number` ; `sourceIndex`: `string` ; `status`: ``"migrated"`` } - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/core/types.d.ts:2 - -___ - -### MigrationStatus - -Ƭ **MigrationStatus**: ``"waiting_to_start"`` \| ``"waiting_for_other_nodes"`` \| ``"running"`` \| ``"completed"`` - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/core/types.d.ts:1 - -___ - -### MutatingOperationRefreshSetting - -Ƭ **MutatingOperationRefreshSetting**: `boolean` \| ``"wait_for"`` - -Elasticsearch Refresh setting for mutating operation - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:132 - -___ - -### PatchCaseArgs - -Ƭ **PatchCaseArgs**: [`PatchCase`](../interfaces/client._internal_namespace.PatchCase.md) & [`ClientArgs`](../interfaces/client._internal_namespace.ClientArgs-1.md) - -#### Defined in - -[x-pack/plugins/cases/server/services/cases/index.ts:103](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L103) - -___ - -### PersistableStateDefinition - -Ƭ **PersistableStateDefinition**<`P`\>: `Partial`<[`PersistableState`](../interfaces/client._internal_namespace.PersistableState.md)<`P`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `P` | extends `SerializableRecord` = `SerializableRecord` | - -#### Defined in - -src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:93 - -___ - -### PublicFeatures - -Ƭ **PublicFeatures**: `Record`<`string`, [`LicenseFeature`](../interfaces/client._internal_namespace.LicenseFeature.md)\> - -Provides information about feature availability for the current license. - -#### Defined in - -x-pack/plugins/licensing/target/types/common/types.d.ts:51 - -___ - -### RouteContentType - -Ƭ **RouteContentType**: ``"application/json"`` \| ``"application/*+json"`` \| ``"application/octet-stream"`` \| ``"application/x-www-form-urlencoded"`` \| ``"multipart/form-data"`` \| ``"text/*"`` - -The set of supported parseable Content-Types - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:27 - -___ - -### RouteMethod - -Ƭ **RouteMethod**: [`SafeRouteMethod`](client._internal_namespace.md#saferoutemethod) \| [`DestructiveRouteMethod`](client._internal_namespace.md#destructiveroutemethod) - -The set of common HTTP methods supported by Kibana routing. - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:17 - -___ - -### RouteValidationFunction - -Ƭ **RouteValidationFunction**<`T`\>: (`data`: `any`, `validationResult`: [`RouteValidationResultFactory`](../interfaces/client._internal_namespace.RouteValidationResultFactory.md)) => { `error?`: `never` ; `value`: `T` } \| { `error`: [`RouteValidationError`](../classes/client._internal_namespace.RouteValidationError.md) ; `value?`: `never` } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Type declaration - -▸ (`data`, `validationResult`): { `error?`: `never` ; `value`: `T` } \| { `error`: [`RouteValidationError`](../classes/client._internal_namespace.RouteValidationError.md) ; `value?`: `never` } - -The custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements. - -**`example`** - -The validation should look something like: -```typescript -interface MyExpectedBody { - bar: string; - baz: number; -} - -const myBodyValidation: RouteValidationFunction = (data, validationResult) => { - const { ok, badRequest } = validationResult; - const { bar, baz } = data || {}; - if (typeof bar === 'string' && typeof baz === 'number') { - return ok({ bar, baz }); - } else { - return badRequest('Wrong payload', ['body']); - } -} -``` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `validationResult` | [`RouteValidationResultFactory`](../interfaces/client._internal_namespace.RouteValidationResultFactory.md) | - -##### Returns - -{ `error?`: `never` ; `value`: `T` } \| { `error`: [`RouteValidationError`](../classes/client._internal_namespace.RouteValidationError.md) ; `value?`: `never` } - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:43 - -___ - -### RouteValidationSpec - -Ƭ **RouteValidationSpec**<`T`\>: `ObjectType` \| `Type`<`T`\> \| [`RouteValidationFunction`](client._internal_namespace.md#routevalidationfunction)<`T`\> - -Allowed property validation options: either @kbn/config-schema validations or custom validation functions - -See [RouteValidationFunction](client._internal_namespace.md#routevalidationfunction) for custom validation. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:57 - -___ - -### RouteValidatorFullConfig - -Ƭ **RouteValidatorFullConfig**<`P`, `Q`, `B`\>: [`RouteValidatorConfig`](../interfaces/client._internal_namespace.RouteValidatorConfig.md)<`P`, `Q`, `B`\> & [`RouteValidatorOptions`](../interfaces/client._internal_namespace.RouteValidatorOptions.md) - -Route validations config and options merged into one object - -#### Type parameters - -| Name | -| :------ | -| `P` | -| `Q` | -| `B` | - -#### Defined in - -src/core/target/types/server/http/router/validator/validator.d.ts:101 - -___ - -### RunFunction - -Ƭ **RunFunction**: () => `Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> - -#### Type declaration - -▸ (): `Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> - -##### Returns - -`Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:64 - -___ - -### RunResult - -Ƭ **RunResult**: [`FailedRunResult`](client._internal_namespace.md#failedrunresult) \| [`SuccessfulRunResult`](client._internal_namespace.md#successfulrunresult) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:59 - -___ - -### SafeRouteMethod - -Ƭ **SafeRouteMethod**: ``"get"`` \| ``"options"`` - -Set of HTTP methods not changing the state of the server. - -#### Defined in - -src/core/target/types/server/http/router/route.d.ts:12 - -___ - -### SavedObjectAttribute - -Ƭ **SavedObjectAttribute**: [`SavedObjectAttributeSingle`](client._internal_namespace.md#savedobjectattributesingle) \| [`SavedObjectAttributeSingle`](client._internal_namespace.md#savedobjectattributesingle)[] - -Type definition for a Saved Object attribute value - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:12 - -___ - -### SavedObjectAttributeSingle - -Ƭ **SavedObjectAttributeSingle**: `string` \| `number` \| `boolean` \| ``null`` \| `undefined` \| [`SavedObjectAttributes`](../interfaces/client._internal_namespace.SavedObjectAttributes.md) - -Don't use this type, it's simply a helper type for [SavedObjectAttribute](client._internal_namespace.md#savedobjectattribute) - -#### Defined in - -src/core/target/types/types/saved_objects.d.ts:6 - -___ - -### SavedObjectFindOptions - -Ƭ **SavedObjectFindOptions**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/saved_object.ts:72](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/saved_object.ts#L72) - -___ - -### SavedObjectFindOptionsKueryNode - -Ƭ **SavedObjectFindOptionsKueryNode**: `Omit`<[`SavedObjectFindOptions`](client._internal_namespace.md#savedobjectfindoptions), ``"filter"``\> & { `filter?`: `KueryNode` } - -#### Defined in - -[x-pack/plugins/cases/server/common/types.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/common/types.ts#L19) - -___ - -### SavedObjectMigrationFn - -Ƭ **SavedObjectMigrationFn**<`InputAttributes`, `MigratedAttributes`\>: (`doc`: [`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`InputAttributes`\>, `context`: [`SavedObjectMigrationContext`](../interfaces/client._internal_namespace.SavedObjectMigrationContext.md)) => [`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`MigratedAttributes`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `InputAttributes` | `unknown` | -| `MigratedAttributes` | `unknown` | - -#### Type declaration - -▸ (`doc`, `context`): [`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`MigratedAttributes`\> - -A migration function for a [saved object type](../interfaces/client._internal_namespace.SavedObjectsType.md) -used to migrate it to a given version - -**`example`** -```typescript -interface TypeV1Attributes { - someKey: string; - obsoleteProperty: number; -} - -interface TypeV2Attributes { - someKey: string; - newProperty: string; -} - -const migrateToV2: SavedObjectMigrationFn = (doc, { log }) => { - const { obsoleteProperty, ...otherAttributes } = doc.attributes; - // instead of mutating `doc` we make a shallow copy so that we can use separate types for the input - // and output attributes. We don't need to make a deep copy, we just need to ensure that obsolete - // attributes are not present on the returned doc. - return { - ...doc, - attributes: { - ...otherAttributes, - newProperty: migrate(obsoleteProperty), - }, - }; -}; -``` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`InputAttributes`\> | -| `context` | [`SavedObjectMigrationContext`](../interfaces/client._internal_namespace.SavedObjectMigrationContext.md) | - -##### Returns - -[`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`MigratedAttributes`\> - -#### Defined in - -src/core/target/types/server/saved_objects/migrations/types.d.ts:39 - -___ - -### SavedObjectTypeExcludeFromUpgradeFilterHook - -Ƭ **SavedObjectTypeExcludeFromUpgradeFilterHook**: (`toolkit`: { `readonlyEsClient`: `Pick`<[`ElasticsearchClient`](client._internal_namespace.md#elasticsearchclient), ``"search"``\> }) => `estypes.QueryDslQueryContainer` \| `Promise`<`estypes.QueryDslQueryContainer`\> - -#### Type declaration - -▸ (`toolkit`): `estypes.QueryDslQueryContainer` \| `Promise`<`estypes.QueryDslQueryContainer`\> - -If defined, allows a type to run a search query and return a query filter that may match any documents which may -be excluded from the next migration upgrade process. Useful for cleaning up large numbers of old documents which -are no longer needed and may slow the migration process. - -If this hook fails, the migration will proceed without these documents having been filtered out, so this -should not be used as a guarantee that these documents have been deleted. - -**`alpha`** Experimental and subject to change - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `toolkit` | `Object` | -| `toolkit.readonlyEsClient` | `Pick`<[`ElasticsearchClient`](client._internal_namespace.md#elasticsearchclient), ``"search"``\> | - -##### Returns - -`estypes.QueryDslQueryContainer` \| `Promise`<`estypes.QueryDslQueryContainer`\> - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:479 - -___ - -### SavedObjectUnsanitizedDoc - -Ƭ **SavedObjectUnsanitizedDoc**<`T`\>: [`SavedObjectDoc`](../interfaces/client._internal_namespace.SavedObjectDoc.md)<`T`\> & `Partial`<[`Referencable`](../interfaces/client._internal_namespace.Referencable.md)\> - -Describes Saved Object documents from Kibana < 7.0.0 which don't have a -`references` root property defined. This type should only be used in -migrations. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Defined in - -src/core/target/types/server/saved_objects/serialization/types.d.ts:49 - -___ - -### SavedObjectsClientContract - -Ƭ **SavedObjectsClientContract**: `Pick`<[`SavedObjectsClient`](../classes/client._internal_namespace.SavedObjectsClient.md), keyof [`SavedObjectsClient`](../classes/client._internal_namespace.SavedObjectsClient.md)\> - -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 [SavedObjectsErrorHelpers](../classes/client._internal_namespace.SavedObjectsErrorHelpers.md) - -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 [SavedObjectsClient](../classes/client._internal_namespace.SavedObjectsClient.md) -See [SavedObjectsErrorHelpers](../classes/client._internal_namespace.SavedObjectsErrorHelpers.md) - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:195 - -___ - -### SavedObjectsCreatePointInTimeFinderOptions - -Ƭ **SavedObjectsCreatePointInTimeFinderOptions**: `Omit`<[`SavedObjectsFindOptions`](../interfaces/client._internal_namespace.SavedObjectsFindOptions.md), ``"page"`` \| ``"pit"`` \| ``"searchAfter"``\> - -#### Defined in - -src/core/target/types/server/saved_objects/service/lib/point_in_time_finder.d.ts:7 - -___ - -### SavedObjectsExportTransform - -Ƭ **SavedObjectsExportTransform**<`T`\>: (`context`: [`SavedObjectsExportTransformContext`](../interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md), `objects`: [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>[]) => [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[] \| `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Type declaration - -▸ (`context`, `objects`): [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[] \| `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[]\> - -Transformation function used to mutate the exported objects of the associated type. - -A type's export transform function will be executed once per user-initiated export, -for all objects of that type. - -**`example`** -Registering a transform function changing the object's attributes during the export -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onExport: (ctx, objects) => { - return objects.map((obj) => ({ - ...obj, - attributes: { - ...obj.attributes, - enabled: false, - } - }) - } - }, - }); - } -} -``` - -**`example`** -Registering a transform function adding additional objects to the export -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - const savedObjectStartContractPromise = getStartServices().then( - ([{ savedObjects: savedObjectsStart }]) => savedObjectsStart - ); - - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onExport: async (ctx, objects) => { - const { getScopedClient } = await savedObjectStartContractPromise; - const client = getScopedClient(ctx.request); - - const depResponse = await client.find({ - type: 'my-nested-object', - hasReference: objs.map(({ id, type }) => ({ id, type })), - }); - - return [...objs, ...depResponse.saved_objects]; - } - }, - }); - } -} -``` - -**`remarks`** Trying to change an object's id or type during the transform will result in - a runtime error during the export process. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`SavedObjectsExportTransformContext`](../interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md) | -| `objects` | [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>[] | - -##### Returns - -[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[] \| `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[]\> - -#### Defined in - -src/core/target/types/server/saved_objects/export/types.d.ts:160 - -___ - -### SavedObjectsExportablePredicate - -Ƭ **SavedObjectsExportablePredicate**<`Attributes`\>: (`obj`: [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`Attributes`\>) => `boolean` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Attributes` | `unknown` | - -#### Type declaration - -▸ (`obj`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`Attributes`\> | - -##### Returns - -`boolean` - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:467 - -___ - -### SavedObjectsFieldMapping - -Ƭ **SavedObjectsFieldMapping**: `estypes.MappingProperty` & { `dynamic?`: ``false`` \| ``"strict"`` } - -Describe a [saved object type mapping](../interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md) field. - -Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) -For the mapping documentation - -#### Defined in - -src/core/target/types/server/saved_objects/mappings/types.d.ts:89 - -___ - -### SavedObjectsImportHook - -Ƭ **SavedObjectsImportHook**<`T`\>: (`objects`: [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>[]) => [`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md) \| `Promise`<[`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md)\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Type declaration - -▸ (`objects`): [`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md) \| `Promise`<[`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md)\> - -A hook associated with a specific saved object type, that will be invoked during -the import process. The hook will have access to the objects of the registered type. - -Currently, the only supported feature for import hooks is to return warnings to be displayed -in the UI when the import succeeds. - -**`remark`** The only interactions the hook can have with the import process is via the hook's - response. Mutating the objects inside the hook's code will have no effect. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `objects` | [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>[] | - -##### Returns - -[`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md) \| `Promise`<[`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md)\> - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:227 - -___ - -### SavedObjectsImportWarning - -Ƭ **SavedObjectsImportWarning**: [`SavedObjectsImportSimpleWarning`](../interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md) \| [`SavedObjectsImportActionRequiredWarning`](../interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md) - -Composite type of all the possible types of import warnings. - -See [SavedObjectsImportSimpleWarning](../interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md) and [SavedObjectsImportActionRequiredWarning](../interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md) -for more details. - -#### Defined in - -src/core/target/types/server/saved_objects/import/types.d.ts:203 - -___ - -### SavedObjectsNamespaceType - -Ƭ **SavedObjectsNamespaceType**: ``"single"`` \| ``"multiple"`` \| ``"multiple-isolated"`` \| ``"agnostic"`` - -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. - -#### Defined in - -src/core/target/types/server/saved_objects/types.d.ts:208 - -___ - -### SavedObjectsValidationSpec - -Ƭ **SavedObjectsValidationSpec**: `ObjectType` - -Allows for validating properties using @kbn/config-schema validations. - -#### Defined in - -src/core/target/types/server/saved_objects/validation/types.d.ts:7 - -___ - -### SpaceIdToNamespaceFunction - -Ƭ **SpaceIdToNamespaceFunction**: (`spaceId?`: `string`) => `string` \| `undefined` - -#### Type declaration - -▸ (`spaceId?`): `string` \| `undefined` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `spaceId?` | `string` | - -##### Returns - -`string` \| `undefined` - -#### Defined in - -x-pack/plugins/actions/target/types/server/types.d.ts:18 - -___ - -### StringKeysAsVals - -Ƭ **StringKeysAsVals**<`T`\>: { [K in keyof T]: string extends K ? never : number extends K ? never : K } - -Converts an object type to a new object type where each string -key is copied to the values of the object, and non string keys are -given a `never` value. This allows us to map over the values and -get the list of all string keys on a type in `KnownKeys` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -src/core/target/types/server/http/router/headers.d.ts:9 - -___ - -### SubFeaturePrivilegeGroupType - -Ƭ **SubFeaturePrivilegeGroupType**: ``"mutually_exclusive"`` \| ``"independent"`` - -The type of privilege group. -- `mutually_exclusive`:: - Users will be able to select at most one privilege within this group. - Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All) -- `independent`:: - Users will be able to select any combination of privileges within this group. - -#### Defined in - -x-pack/plugins/features/target/types/common/sub_feature.d.ts:21 - -___ - -### SuccessfulRunResult - -Ƭ **SuccessfulRunResult**: { `state`: `Record`<`string`, `unknown`\> } & { `runAt?`: `Date` ; `schedule?`: `never` } \| { `runAt?`: `never` ; `schedule?`: [`IntervalSchedule`](../interfaces/client._internal_namespace.IntervalSchedule.md) } - -The return value of a task's run function should be a promise of RunResult. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:28 - -___ - -### TaskDefinitionRegistry - -Ƭ **TaskDefinitionRegistry**: `Record`<`string`, [`TaskRegisterDefinition`](../interfaces/client._internal_namespace.TaskRegisterDefinition.md)\> - -A mapping of task type id to the task definition. - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:52 - -___ - -### TaskRunCreatorFunction - -Ƭ **TaskRunCreatorFunction**: (`context`: [`RunContext`](../interfaces/client._internal_namespace.RunContext.md)) => [`CancellableTask`](../interfaces/client._internal_namespace.CancellableTask.md) - -#### Type declaration - -▸ (`context`): [`CancellableTask`](../interfaces/client._internal_namespace.CancellableTask.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`RunContext`](../interfaces/client._internal_namespace.RunContext.md) | - -##### Returns - -[`CancellableTask`](../interfaces/client._internal_namespace.CancellableTask.md) - -#### Defined in - -x-pack/plugins/task_manager/target/types/server/task.d.ts:70 - -___ - -### UpdateAttachmentArgs - -Ƭ **UpdateAttachmentArgs**: [`UpdateArgs`](../interfaces/client._internal_namespace.UpdateArgs.md) & [`ClientArgs`](../interfaces/client._internal_namespace.ClientArgs-1.md) - -#### Defined in - -[x-pack/plugins/cases/server/services/attachments/index.ts:59](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L59) - -___ - -### UserAction - -Ƭ **UserAction**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/user_actions/index.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/index.ts#L85) - -___ - -### UserActionParameters - -Ƭ **UserActionParameters**<`T`\>: [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md)[`T`][``"parameters"``] & [`CommonArguments`](../interfaces/client._internal_namespace.CommonArguments.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends keyof [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md) | - -#### Defined in - -[x-pack/plugins/cases/server/services/user_actions/types.ts:71](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L71) - -___ - -### UserActionTypes - -Ƭ **UserActionTypes**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/user_actions/index.ts:86](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/index.ts#L86) - -## Variables - -### ActionTypesRt - -• **ActionTypesRt**: `KeyofC`<{ `comment`: ``"comment"`` = 'comment'; `connector`: ``"connector"`` = 'connector'; `create_case`: ``"create_case"`` = 'create\_case'; `delete_case`: ``"delete_case"`` = 'delete\_case'; `description`: ``"description"`` = 'description'; `pushed`: ``"pushed"`` = 'pushed'; `settings`: ``"settings"`` = 'settings'; `status`: ``"status"`` = 'status'; `tags`: ``"tags"`` = 'tags'; `title`: ``"title"`` = 'title' }\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/user_actions/common.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/common.ts#L35) - -___ - -### ActionsRt - -• **ActionsRt**: `KeyofC`<{ `add`: ``"add"`` = 'add'; `create`: ``"create"`` = 'create'; `delete`: ``"delete"`` = 'delete'; `push_to_service`: ``"push_to_service"`` = 'push\_to\_service'; `update`: ``"update"`` = 'update' }\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/user_actions/common.ts:36](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/common.ts#L36) - -___ - -### CasesFindRequestRt - -• **CasesFindRequestRt**: `PartialC`<{ `defaultSearchOperator`: `UnionC`<[`LiteralC`<``"AND"``\>, `LiteralC`<``"OR"``\>]\> ; `fields`: `ArrayC`<`StringC`\> ; `owner`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `page`: `Type`<`number`, `string`, `unknown`\> = NumberFromString; `perPage`: `Type`<`number`, `string`, `unknown`\> = NumberFromString; `reporters`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `search`: `StringC` = rt.string; `searchFields`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `sortField`: `StringC` = rt.string; `sortOrder`: `UnionC`<[`LiteralC`<``"desc"``\>, `LiteralC`<``"asc"``\>]\> ; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> }\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:136](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L136) - -___ - -### EventSchema - -• **EventSchema**: `Type` - -#### Defined in - -x-pack/plugins/event_log/target/types/generated/schemas.d.ts:11 - -___ - -### SavedObjectFindOptionsRt - -• **SavedObjectFindOptionsRt**: `PartialC`<{ `defaultSearchOperator`: `UnionC`<[`LiteralC`<``"AND"``\>, `LiteralC`<``"OR"``\>]\> ; `fields`: `ArrayC`<`StringC`\> ; `filter`: `StringC` = rt.string; `hasReference`: `UnionC`<[`ArrayC`<`TypeC`<{ `id`: `StringC` = rt.string; `type`: `StringC` = rt.string }\>\>, `TypeC`<{ `id`: `StringC` = rt.string; `type`: `StringC` = rt.string }\>]\> ; `hasReferenceOperator`: `UnionC`<[`LiteralC`<``"AND"``\>, `LiteralC`<``"OR"``\>]\> ; `page`: `Type`<`number`, `string`, `unknown`\> = NumberFromString; `perPage`: `Type`<`number`, `string`, `unknown`\> = NumberFromString; `search`: `StringC` = rt.string; `searchFields`: `ArrayC`<`StringC`\> ; `sortField`: `StringC` = rt.string; `sortOrder`: `UnionC`<[`LiteralC`<``"desc"``\>, `LiteralC`<``"asc"``\>]\> }\> - -#### Defined in - -[x-pack/plugins/cases/common/api/saved_object.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/saved_object.ts#L25) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/client.md b/x-pack/plugins/cases/docs/cases_client/modules/client.md deleted file mode 100644 index b03a7ba7673bbc..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/client.md +++ /dev/null @@ -1,13 +0,0 @@ -[Cases Client API Interface](../README.md) / client - -# Module: client - -## Table of contents - -### Namespaces - -- [\_internal\_namespace](client._internal_namespace.md) - -### Classes - -- [CasesClient](../classes/client.CasesClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/configure_client._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/configure_client._internal_namespace.md deleted file mode 100644 index cb22acb5a298ce..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/configure_client._internal_namespace.md +++ /dev/null @@ -1,13 +0,0 @@ -[Cases Client API Interface](../README.md) / [configure/client](configure_client.md) / \_internal\_namespace - -# Namespace: \_internal\_namespace - -[configure/client](configure_client.md)._internal_namespace - -## Table of contents - -### Interfaces - -- [CreateMappingsArgs](../interfaces/configure_client._internal_namespace.CreateMappingsArgs.md) -- [MappingsArgs](../interfaces/configure_client._internal_namespace.MappingsArgs.md) -- [UpdateMappingsArgs](../interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/configure_client.md b/x-pack/plugins/cases/docs/cases_client/modules/configure_client.md deleted file mode 100644 index 690afd51a4f655..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/configure_client.md +++ /dev/null @@ -1,37 +0,0 @@ -[Cases Client API Interface](../README.md) / configure/client - -# Module: configure/client - -## Table of contents - -### Namespaces - -- [\_internal\_namespace](configure_client._internal_namespace.md) - -### Interfaces - -- [ConfigureSubClient](../interfaces/configure_client.ConfigureSubClient.md) - -### Functions - -- [getConnectors](configure_client.md#getconnectors) - -## Functions - -### getConnectors - -▸ **getConnectors**(`__namedParameters`): `Promise`<[`FindActionResult`](../interfaces/client._internal_namespace.FindActionResult.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | - -#### Returns - -`Promise`<[`FindActionResult`](../interfaces/client._internal_namespace.FindActionResult.md)[]\> - -#### Defined in - -[x-pack/plugins/cases/server/client/configure/client.ts:206](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L206) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/metrics_client._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/metrics_client._internal_namespace.md deleted file mode 100644 index 318b5177474942..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/metrics_client._internal_namespace.md +++ /dev/null @@ -1,11 +0,0 @@ -[Cases Client API Interface](../README.md) / [metrics/client](metrics_client.md) / \_internal\_namespace - -# Namespace: \_internal\_namespace - -[metrics/client](metrics_client.md)._internal_namespace - -## Table of contents - -### Interfaces - -- [CaseMetricsParams](../interfaces/metrics_client._internal_namespace.CaseMetricsParams.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/metrics_client.md b/x-pack/plugins/cases/docs/cases_client/modules/metrics_client.md deleted file mode 100644 index c4c7354ba5afee..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/metrics_client.md +++ /dev/null @@ -1,13 +0,0 @@ -[Cases Client API Interface](../README.md) / metrics/client - -# Module: metrics/client - -## Table of contents - -### Namespaces - -- [\_internal\_namespace](metrics_client._internal_namespace.md) - -### Interfaces - -- [MetricsSubClient](../interfaces/metrics_client.MetricsSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/stats_client.md b/x-pack/plugins/cases/docs/cases_client/modules/stats_client.md deleted file mode 100644 index f0632f6ca00691..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/stats_client.md +++ /dev/null @@ -1,9 +0,0 @@ -[Cases Client API Interface](../README.md) / stats/client - -# Module: stats/client - -## Table of contents - -### Interfaces - -- [StatsSubClient](../interfaces/stats_client.StatsSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces._internal_namespace.md deleted file mode 100644 index 38b2fc2ea51509..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces._internal_namespace.md +++ /dev/null @@ -1,277 +0,0 @@ -[Cases Client API Interface](../README.md) / [typedoc\_interfaces](typedoc_interfaces.md) / \_internal\_namespace - -# Namespace: \_internal\_namespace - -[typedoc_interfaces](typedoc_interfaces.md)._internal_namespace - -## Table of contents - -### Type aliases - -- [AllCommentsResponse](typedoc_interfaces._internal_namespace.md#allcommentsresponse) -- [CasePostRequest](typedoc_interfaces._internal_namespace.md#casepostrequest) -- [CaseResolveResponse](typedoc_interfaces._internal_namespace.md#caseresolveresponse) -- [CaseResponse](typedoc_interfaces._internal_namespace.md#caseresponse) -- [CaseUserActionsResponse](typedoc_interfaces._internal_namespace.md#caseuseractionsresponse) -- [CasesConfigurePatch](typedoc_interfaces._internal_namespace.md#casesconfigurepatch) -- [CasesConfigureRequest](typedoc_interfaces._internal_namespace.md#casesconfigurerequest) -- [CasesConfigureResponse](typedoc_interfaces._internal_namespace.md#casesconfigureresponse) -- [CasesFindResponse](typedoc_interfaces._internal_namespace.md#casesfindresponse) -- [CasesPatchRequest](typedoc_interfaces._internal_namespace.md#casespatchrequest) -- [CasesResponse](typedoc_interfaces._internal_namespace.md#casesresponse) -- [CommentsResponse](typedoc_interfaces._internal_namespace.md#commentsresponse) - -### Variables - -- [AllCommentsResponseRt](typedoc_interfaces._internal_namespace.md#allcommentsresponsert) -- [CaseConfigureResponseRt](typedoc_interfaces._internal_namespace.md#caseconfigureresponsert) -- [CasePostRequestRt](typedoc_interfaces._internal_namespace.md#casepostrequestrt) -- [CaseResolveResponseRt](typedoc_interfaces._internal_namespace.md#caseresolveresponsert) -- [CaseResponseRt](typedoc_interfaces._internal_namespace.md#caseresponsert) -- [CaseUserActionsResponseRt](typedoc_interfaces._internal_namespace.md#caseuseractionsresponsert) -- [CasesConfigurePatchRt](typedoc_interfaces._internal_namespace.md#casesconfigurepatchrt) -- [CasesConfigureRequestRt](typedoc_interfaces._internal_namespace.md#casesconfigurerequestrt) -- [CasesFindResponseRt](typedoc_interfaces._internal_namespace.md#casesfindresponsert) -- [CasesPatchRequestRt](typedoc_interfaces._internal_namespace.md#casespatchrequestrt) -- [CasesResponseRt](typedoc_interfaces._internal_namespace.md#casesresponsert) -- [CommentsResponseRt](typedoc_interfaces._internal_namespace.md#commentsresponsert) - -## Type aliases - -### AllCommentsResponse - -Ƭ **AllCommentsResponse**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/comment.ts:166](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L166) - -___ - -### CasePostRequest - -Ƭ **CasePostRequest**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:280](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L280) - -___ - -### CaseResolveResponse - -Ƭ **CaseResolveResponse**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:282](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L282) - -___ - -### CaseResponse - -Ƭ **CaseResponse**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:281](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L281) - -___ - -### CaseUserActionsResponse - -Ƭ **CaseUserActionsResponse**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/user_actions/index.ts:82](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/index.ts#L82) - -___ - -### CasesConfigurePatch - -Ƭ **CasesConfigurePatch**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/configure.ts:81](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L81) - -___ - -### CasesConfigureRequest - -Ƭ **CasesConfigureRequest**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/configure.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L80) - -___ - -### CasesConfigureResponse - -Ƭ **CasesConfigureResponse**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/configure.ts:83](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L83) - -___ - -### CasesFindResponse - -Ƭ **CasesFindResponse**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:286](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L286) - -___ - -### CasesPatchRequest - -Ƭ **CasesPatchRequest**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:288](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L288) - -___ - -### CasesResponse - -Ƭ **CasesResponse**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:283](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L283) - -___ - -### CommentsResponse - -Ƭ **CommentsResponse**: `rt.TypeOf` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/comment.ts:167](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L167) - -## Variables - -### AllCommentsResponseRt - -• **AllCommentsResponseRt**: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/comment.ts:150](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L150) - -___ - -### CaseConfigureResponseRt - -• **CaseConfigureResponseRt**: `IntersectionC`<[`IntersectionC`<[`IntersectionC`<[`TypeC`<{ `closure_type`: `UnionC`<[`LiteralC`<``"close-by-user"``\>, `LiteralC`<``"close-by-pushing"``\>]\> = ClosureTypeRT; `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\>, `TypeC`<{ `owner`: `StringC` = rt.string }\>]\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `mappings`: `ArrayC`<`TypeC`<{ `action_type`: `UnionC`<[`LiteralC`<``"append"``\>, `LiteralC`<``"nothing"``\>, `LiteralC`<``"overwrite"``\>]\> = ActionTypeRT; `source`: `UnionC`<[`LiteralC`<``"title"``\>, `LiteralC`<``"description"``\>, `LiteralC`<``"comments"``\>]\> = CaseFieldRT; `target`: `UnionC`<[`StringC`, `LiteralC`<``"not_mapped"``\>]\> = ThirdPartyFieldRT }\>\> ; `owner`: `StringC` = rt.string }\>, `TypeC`<{ `error`: `UnionC`<[`StringC`, `NullC`]\> ; `id`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/configure.ts:53](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L53) - -___ - -### CasePostRequestRt - -• **CasePostRequestRt**: `TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:108](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L108) - -___ - -### CaseResolveResponseRt - -• **CaseResolveResponseRt**: `IntersectionC`<[`TypeC`<{ `case`: `IntersectionC`<[`IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `closed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `closed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `external_service`: `UnionC`<[`IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\>, `NullC`]\> = CaseFullExternalServiceRt; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `totalAlerts`: `NumberC` = rt.number; `totalComment`: `NumberC` = rt.number; `version`: `StringC` = rt.string }\>, `PartialC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\>]\> = CaseResponseRt; `outcome`: `UnionC`<[`LiteralC`<``"exactMatch"``\>, `LiteralC`<``"aliasMatch"``\>, `LiteralC`<``"conflict"``\>]\> }\>, `PartialC`<{ `alias_target_id`: `StringC` = rt.string }\>]\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:212](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L212) - -___ - -### CaseResponseRt - -• **CaseResponseRt**: `IntersectionC`<[`IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `closed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `closed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `external_service`: `UnionC`<[`IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\>, `NullC`]\> = CaseFullExternalServiceRt; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `totalAlerts`: `NumberC` = rt.number; `totalComment`: `NumberC` = rt.number; `version`: `StringC` = rt.string }\>, `PartialC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\>]\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:199](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L199) - -___ - -### CaseUserActionsResponseRt - -• **CaseUserActionsResponseRt**: `ArrayC`<`IntersectionC`<[`IntersectionC`<[`UnionC`<[`UnionC`<[`TypeC`<{ `payload`: `TypeC`<{ `description`: `StringC` = rt.string }\> = DescriptionUserActionPayloadRt; `type`: `LiteralC`<``"description"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `comment`: `UnionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>]\> = CommentRequestRt }\> = CommentUserActionPayloadRt; `type`: `LiteralC`<``"comment"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `tags`: `ArrayC`<`StringC`\> }\> = TagsUserActionPayloadRt; `type`: `LiteralC`<``"tags"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `title`: `StringC` = rt.string }\> = TitleUserActionPayloadRt; `type`: `LiteralC`<``"title"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt }\> = SettingsUserActionPayloadRt; `type`: `LiteralC`<``"settings"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt }\> = StatusUserActionPayloadRt; `type`: `LiteralC`<``"status"``\> }\>]\>, `IntersectionC`<[`TypeC`<{ `type`: `LiteralC`<``"create_case"``\> }\>, `TypeC`<{ `payload`: `IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\>, `TypeC`<{ `description`: `StringC` = DescriptionUserActionPayloadRt.props.description; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsUserActionPayloadRt.props.settings; `status`: `StringC` = rt.string; `tags`: `ArrayC`<`StringC`\> = TagsUserActionPayloadRt.props.tags; `title`: `StringC` = TitleUserActionPayloadRt.props.title }\>]\> }\>]\>, `TypeC`<{ `payload`: `TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\> = ConnectorUserActionPayloadRt; `type`: `LiteralC`<``"connector"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `externalService`: `IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\> = CaseExternalServiceBasicRt }\> = PushedUserActionPayloadRt; `type`: `LiteralC`<``"pushed"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{}\> ; `type`: `LiteralC`<``"delete_case"``\> }\>]\>, `TypeC`<{ `action`: `KeyofC`<{ `add`: ``"add"`` = 'add'; `create`: ``"create"`` = 'create'; `delete`: ``"delete"`` = 'delete'; `push_to_service`: ``"push_to_service"`` = 'push\_to\_service'; `update`: ``"update"`` = 'update' }\> = ActionsRt; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string }\>]\>, `TypeC`<{ `action_id`: `StringC` = rt.string; `case_id`: `StringC` = rt.string; `comment_id`: `UnionC`<[`StringC`, `NullC`]\> }\>]\>\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/user_actions/index.ts:76](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/index.ts#L76) - -___ - -### CasesConfigurePatchRt - -• **CasesConfigurePatchRt**: `IntersectionC`<[`PartialC`<{ `closure_type`: `UnionC`<[`LiteralC`<``"close-by-user"``\>, `LiteralC`<``"close-by-pushing"``\>]\> = ClosureTypeRT; `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\>, `TypeC`<{ `version`: `StringC` = rt.string }\>]\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/configure.ts:38](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L38) - -___ - -### CasesConfigureRequestRt - -• **CasesConfigureRequestRt**: `IntersectionC`<[`TypeC`<{ `closure_type`: `UnionC`<[`LiteralC`<``"close-by-user"``\>, `LiteralC`<``"close-by-pushing"``\>]\> = ClosureTypeRT; `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\>, `TypeC`<{ `owner`: `StringC` = rt.string }\>]\> = `CasesConfigureBasicRt` - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/configure.ts:37](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L37) - -___ - -### CasesFindResponseRt - -• **CasesFindResponseRt**: `IntersectionC`<[`TypeC`<{ `cases`: `ArrayC`<`IntersectionC`<[`IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `closed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `closed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `external_service`: `UnionC`<[`IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\>, `NullC`]\> = CaseFullExternalServiceRt; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `totalAlerts`: `NumberC` = rt.number; `totalComment`: `NumberC` = rt.number; `version`: `StringC` = rt.string }\>, `PartialC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\>]\>\> ; `page`: `NumberC` = rt.number; `per_page`: `NumberC` = rt.number; `total`: `NumberC` = rt.number }\>, `TypeC`<{ `count_closed_cases`: `NumberC` = rt.number; `count_in_progress_cases`: `NumberC` = rt.number; `count_open_cases`: `NumberC` = rt.number }\>]\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:222](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L222) - -___ - -### CasesPatchRequestRt - -• **CasesPatchRequestRt**: `TypeC`<{ `cases`: `ArrayC`<`IntersectionC`<[`PartialC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:240](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L240) - -___ - -### CasesResponseRt - -• **CasesResponseRt**: `ArrayC`<`IntersectionC`<[`IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `closed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `closed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `external_service`: `UnionC`<[`IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\>, `NullC`]\> = CaseFullExternalServiceRt; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `totalAlerts`: `NumberC` = rt.number; `totalComment`: `NumberC` = rt.number; `version`: `StringC` = rt.string }\>, `PartialC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\>]\>\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/case.ts:241](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L241) - -___ - -### CommentsResponseRt - -• **CommentsResponseRt**: `TypeC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> ; `page`: `NumberC` = rt.number; `per_page`: `NumberC` = rt.number; `total`: `NumberC` = rt.number }\> - -#### Defined in - -[x-pack/plugins/cases/common/api/cases/comment.ts:143](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L143) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces.md b/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces.md deleted file mode 100644 index 9f9d1f9a8808cf..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces.md +++ /dev/null @@ -1,28 +0,0 @@ -[Cases Client API Interface](../README.md) / typedoc\_interfaces - -# Module: typedoc\_interfaces - -This file defines simpler types for typedoc. This helps reduce the type alias expansion for the io-ts types because it -can be very large. These types are equivalent to the io-ts aliases. - -## Table of contents - -### Namespaces - -- [\_internal\_namespace](typedoc_interfaces._internal_namespace.md) - -### Interfaces - -- [IAllCommentsResponse](../interfaces/typedoc_interfaces.IAllCommentsResponse.md) -- [ICasePostRequest](../interfaces/typedoc_interfaces.ICasePostRequest.md) -- [ICaseResolveResponse](../interfaces/typedoc_interfaces.ICaseResolveResponse.md) -- [ICaseResponse](../interfaces/typedoc_interfaces.ICaseResponse.md) -- [ICaseUserActionsResponse](../interfaces/typedoc_interfaces.ICaseUserActionsResponse.md) -- [ICasesConfigurePatch](../interfaces/typedoc_interfaces.ICasesConfigurePatch.md) -- [ICasesConfigureRequest](../interfaces/typedoc_interfaces.ICasesConfigureRequest.md) -- [ICasesConfigureResponse](../interfaces/typedoc_interfaces.ICasesConfigureResponse.md) -- [ICasesFindRequest](../interfaces/typedoc_interfaces.ICasesFindRequest.md) -- [ICasesFindResponse](../interfaces/typedoc_interfaces.ICasesFindResponse.md) -- [ICasesPatchRequest](../interfaces/typedoc_interfaces.ICasesPatchRequest.md) -- [ICasesResponse](../interfaces/typedoc_interfaces.ICasesResponse.md) -- [ICommentsResponse](../interfaces/typedoc_interfaces.ICommentsResponse.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/user_actions_client.md b/x-pack/plugins/cases/docs/cases_client/modules/user_actions_client.md deleted file mode 100644 index 4ec27e0beee468..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/user_actions_client.md +++ /dev/null @@ -1,10 +0,0 @@ -[Cases Client API Interface](../README.md) / user\_actions/client - -# Module: user\_actions/client - -## Table of contents - -### Interfaces - -- [UserActionGet](../interfaces/user_actions_client.UserActionGet.md) -- [UserActionsSubClient](../interfaces/user_actions_client.UserActionsSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client_typedoc.json b/x-pack/plugins/cases/docs/cases_client_typedoc.json deleted file mode 100644 index a5e1305196491b..00000000000000 --- a/x-pack/plugins/cases/docs/cases_client_typedoc.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "entryPoints": [ - "../server/client/client.ts", - "../server/client/typedoc_interfaces.ts", - "../server/client/attachments/client.ts", - "../server/client/cases/client.ts", - "../server/client/cases/get.ts", - "../server/client/cases/push.ts", - "../server/client/configure/client.ts", - "../server/client/metrics/client.ts", - "../server/client/stats/client.ts", - "../server/client/user_actions/client.ts" - ], - "entryPointStrategy": "expand", - "exclude": [ - "**/mock.ts", - "../server/client/cases/+(mock.ts|utils.ts|utils.test.ts|types.ts)" - ], - "excludeExternals": true, - "out": "cases_client", - "theme": "markdown", - "internalNamespace": "_internal_namespace", - "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-missing-exports"], - "readme": "none", - "name": "Cases Client API Interface", - "gitRemote": "upstream" -} diff --git a/x-pack/plugins/data_visualizer/common/types/field_request_config.ts b/x-pack/plugins/data_visualizer/common/types/field_request_config.ts index f0ea7079bf750a..e15e39ffb46de4 100644 --- a/x-pack/plugins/data_visualizer/common/types/field_request_config.ts +++ b/x-pack/plugins/data_visualizer/common/types/field_request_config.ts @@ -17,6 +17,7 @@ export interface FieldRequestConfig { fieldName: string; type: JobFieldType; cardinality: number; + existsInDocs: boolean; } export interface DocumentCountBuckets { diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/filter_fields.ts b/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/filter_fields.ts index de97b6007d877a..145a8fa5f8867d 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/filter_fields.ts +++ b/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/filter_fields.ts @@ -6,15 +6,15 @@ */ import { JOB_FIELD_TYPES } from '../../../../../common/constants'; -import type { - FileBasedFieldVisConfig, - FileBasedUnknownFieldVisConfig, -} from '../../../../../common/types/field_vis_config'; -export function filterFields( - fields: Array, - visibleFieldNames: string[], - visibleFieldTypes: string[] +interface CommonFieldConfig { + type: string; + fieldName?: string; +} +export function filterFields( + fields: T[], + visibleFieldNames: string[] | undefined, + visibleFieldTypes: string[] | undefined ) { let items = fields; diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/data_visualizer_stats_table.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/data_visualizer_stats_table.tsx index cc9cd075c76153..5d4c4de8ca9015 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/data_visualizer_stats_table.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/data_visualizer_stats_table.tsx @@ -19,6 +19,7 @@ import { LEFT_ALIGNMENT, RIGHT_ALIGNMENT, EuiResizeObserver, + EuiLoadingSpinner, } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { EuiTableComputedColumnType } from '@elastic/eui/src/components/basic_table/table_types'; @@ -279,6 +280,15 @@ export const DataVisualizerTable = ({ ), render: (item: DataVisualizerTableItem) => { if (item === undefined || showDistributions === false) return null; + + if ('loading' in item && item.loading === true) { + return ( + + + + ); + } + if ( (item.type === JOB_FIELD_TYPES.KEYWORD || item.type === JOB_FIELD_TYPES.IP) && item.stats?.topValues !== undefined diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/constants/index_data_visualizer_viewer.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/constants/index_data_visualizer_viewer.ts index cd12706d0bc9ba..c1b314a19cf378 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/constants/index_data_visualizer_viewer.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/constants/index_data_visualizer_viewer.ts @@ -6,3 +6,5 @@ */ export const DATA_VISUALIZER_INDEX_VIEWER = 'DATA_VISUALIZER_INDEX_VIEWER'; + +export const MAX_CONCURRENT_REQUESTS = 10; diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx index 8097d400c3b71f..c44932470c7e8a 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/embeddables/grid_embeddable/grid_embeddable.tsx @@ -84,6 +84,7 @@ export const EmbeddableWrapper = ({ }, [dataVisualizerListState, onOutputChange] ); + const { configs, searchQueryLanguage, searchString, extendedColumns, progress, setLastRefresh } = useDataVisualizerGridData(input, dataVisualizerListState); diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts index bbf088c53d94ca..7c821f698d8df3 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts @@ -53,7 +53,6 @@ export const useDataVisualizerGridData = ( const { services } = useDataVisualizerKibana(); const { uiSettings, data } = services; const { samplerShardSize, visibleFieldTypes, showEmptyFields } = dataVisualizerListState; - const dataVisualizerListStateRef = useRef(dataVisualizerListState); const [lastRefresh, setLastRefresh] = useState(0); const searchSessionId = input.sessionId; @@ -227,11 +226,11 @@ export const useDataVisualizerGridData = ( if (overallStatsProgress.loaded < 100) return; const existMetricFields = metricConfigs .map((config) => { - if (config.existsInDocs === false) return; return { fieldName: config.fieldName, type: config.type, cardinality: config.stats?.cardinality ?? 0, + existsInDocs: config.existsInDocs, }; }) .filter((c) => c !== undefined) as FieldRequestConfig[]; @@ -240,11 +239,11 @@ export const useDataVisualizerGridData = ( // Top values will be obtained on a sample if cardinality > 100000. const existNonMetricFields: FieldRequestConfig[] = nonMetricConfigs .map((config) => { - if (config.existsInDocs === false) return; return { fieldName: config.fieldName, type: config.type, cardinality: config.stats?.cardinality ?? 0, + existsInDocs: config.existsInDocs, }; }) .filter((c) => c !== undefined) as FieldRequestConfig[]; @@ -255,7 +254,7 @@ export const useDataVisualizerGridData = ( const strategyResponse = useFieldStatsSearchStrategy( fieldStatsRequest, configsWithoutStats, - dataVisualizerListStateRef.current + dataVisualizerListState ); const combinedProgress = useMemo( @@ -325,7 +324,7 @@ export const useDataVisualizerGridData = ( ...fieldData, fieldFormat: currentDataView.getFormatterForField(field), type: JOB_FIELD_TYPES.NUMBER, - loading: true, + loading: fieldData?.existsInDocs ?? true, aggregatable: true, deletable: field.runtimeField !== undefined, }; @@ -436,41 +435,46 @@ export const useDataVisualizerGridData = ( // eslint-disable-next-line react-hooks/exhaustive-deps }, [overallStats, showEmptyFields]); - const configs = useMemo(() => { - const fieldStats = strategyResponse.fieldStats; - let combinedConfigs = [...nonMetricConfigs, ...metricConfigs]; - if (visibleFieldTypes && visibleFieldTypes.length > 0) { - combinedConfigs = combinedConfigs.filter( - (config) => visibleFieldTypes.findIndex((field) => field === config.type) > -1 - ); - } - if (visibleFieldNames && visibleFieldNames.length > 0) { - combinedConfigs = combinedConfigs.filter( - (config) => visibleFieldNames.findIndex((field) => field === config.fieldName) > -1 - ); - } - - if (fieldStats) { - combinedConfigs = combinedConfigs.map((c) => { - const loadedFullStats = fieldStats.get(c.fieldName) ?? {}; - return loadedFullStats - ? { - ...c, - loading: false, - stats: { ...c.stats, ...loadedFullStats }, - } - : c; - }); - } + const configs = useMemo( + () => { + const fieldStats = strategyResponse.fieldStats; + let combinedConfigs = [...nonMetricConfigs, ...metricConfigs]; + if (visibleFieldTypes && visibleFieldTypes.length > 0) { + combinedConfigs = combinedConfigs.filter( + (config) => visibleFieldTypes.findIndex((field) => field === config.type) > -1 + ); + } + if (visibleFieldNames && visibleFieldNames.length > 0) { + combinedConfigs = combinedConfigs.filter( + (config) => visibleFieldNames.findIndex((field) => field === config.fieldName) > -1 + ); + } - return combinedConfigs; - }, [ - nonMetricConfigs, - metricConfigs, - visibleFieldTypes, - visibleFieldNames, - strategyResponse.fieldStats, - ]); + if (fieldStats) { + combinedConfigs = combinedConfigs.map((c) => { + const loadedFullStats = fieldStats.get(c.fieldName) ?? {}; + return loadedFullStats + ? { + ...c, + loading: false, + stats: { ...c.stats, ...loadedFullStats }, + } + : c; + }); + } + return combinedConfigs; + }, + // eslint-disable-next-line react-hooks/exhaustive-deps + [ + nonMetricConfigs, + metricConfigs, + visibleFieldTypes, + visibleFieldNames, + strategyResponse.progress.loaded, + dataVisualizerListState.pageIndex, + dataVisualizerListState.pageSize, + ] + ); // Some actions open up fly-out or popup // This variable is used to keep track of them and clean up when unmounting diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_field_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_field_stats.ts index 19eaf8be68327a..750c1d417e84dd 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_field_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_field_stats.ts @@ -6,10 +6,11 @@ */ import { useCallback, useEffect, useReducer, useRef, useState } from 'react'; -import { combineLatest, Observable, Subject, Subscription } from 'rxjs'; +import { combineLatest, from, Observable, Subject, Subscription } from 'rxjs'; import { i18n } from '@kbn/i18n'; import { last, cloneDeep } from 'lodash'; -import { switchMap } from 'rxjs/operators'; +import { mergeMap, switchMap } from 'rxjs/operators'; +import { Comparators } from '@elastic/eui'; import type { DataStatsFetchProgress, FieldStatsSearchStrategyReturnBase, @@ -29,6 +30,9 @@ import { getInitialProgress, getReducer } from '../progress_utils'; import { MAX_EXAMPLES_DEFAULT } from '../search_strategy/requests/constants'; import type { ISearchOptions } from '../../../../../../../src/plugins/data/common'; import { getFieldsStats } from '../search_strategy/requests/get_fields_stats'; +import { MAX_CONCURRENT_REQUESTS } from '../constants/index_data_visualizer_viewer'; +import { filterFields } from '../../common/components/fields_stats_grid/filter_fields'; + interface FieldStatsParams { metricConfigs: FieldRequestConfig[]; nonMetricConfigs: FieldRequestConfig[]; @@ -61,7 +65,7 @@ const createBatchedRequests = (fields: Field[], maxBatchSize = 10) => { export function useFieldStatsSearchStrategy( searchStrategyParams: OverallStatsSearchStrategyParams | undefined, fieldStatsParams: FieldStatsParams | undefined, - initialDataVisualizerListState: DataVisualizerIndexBasedAppState + dataVisualizerListState: DataVisualizerIndexBasedAppState ): FieldStatsSearchStrategyReturnBase { const { services: { @@ -106,19 +110,41 @@ export function useFieldStatsSearchStrategy( return; } - const { sortField, sortDirection } = initialDataVisualizerListState; + const { sortField, sortDirection } = dataVisualizerListState; /** * Sort the list of fields by the initial sort field and sort direction * Then divide into chunks by the initial page size */ - let sortedConfigs = [...fieldStatsParams.metricConfigs, ...fieldStatsParams.nonMetricConfigs]; + const itemsSorter = Comparators.property( + sortField as string, + Comparators.default(sortDirection as 'asc' | 'desc' | undefined) + ); - if (sortField === 'fieldName' || sortField === 'type') { - sortedConfigs = sortedConfigs.sort((a, b) => a[sortField].localeCompare(b[sortField])); - } - if (sortDirection === 'desc') { - sortedConfigs = sortedConfigs.reverse(); + const preslicedSortedConfigs = [ + ...fieldStatsParams.metricConfigs, + ...fieldStatsParams.nonMetricConfigs, + ].sort(itemsSorter); + + const filteredItems = filterFields( + preslicedSortedConfigs, + dataVisualizerListState.visibleFieldNames, + dataVisualizerListState.visibleFieldTypes + ); + + const { pageIndex, pageSize } = dataVisualizerListState; + + const pageOfConfigs = filteredItems.filteredFields + ?.slice(pageIndex * pageSize, (pageIndex + 1) * pageSize) + .filter((d) => d.existsInDocs === true); + + if (!pageOfConfigs || pageOfConfigs.length === 0) { + setFetchState({ + loaded: 100, + isRunning: false, + }); + + return; } const filterCriteria = buildBaseFilterCriteria( @@ -149,7 +175,7 @@ export function useFieldStatsSearchStrategy( }; const batches = createBatchedRequests( - sortedConfigs.map((config, idx) => ({ + pageOfConfigs.map((config, idx) => ({ fieldName: config.fieldName, type: config.type, cardinality: config.cardinality, @@ -161,11 +187,10 @@ export function useFieldStatsSearchStrategy( const statsMap$ = new Subject(); const fieldsToRetry$ = new Subject(); - const fieldStatsSub = combineLatest( - batches - .map((batch) => getFieldsStats(data.search, params, batch, searchOptions)) - .filter((obs) => obs !== undefined) as Array> - ); + const fieldStatsToFetch = batches + .map((batch) => getFieldsStats(data.search, params, batch, searchOptions)) + .filter((obs) => obs !== undefined) as Array>; + const onError = (error: any) => { toasts.addError(error, { title: i18n.translate('xpack.dataVisualizer.index.errorFetchingFieldStatisticsMessage', { @@ -184,17 +209,24 @@ export function useFieldStatsSearchStrategy( }); }; + const statsMapTmp = new Map(); + // First, attempt to fetch field stats in batches of 10 - searchSubscription$.current = fieldStatsSub.subscribe({ - next: (resp) => { - if (resp) { - const statsMap = new Map(); - const failedFields: Field[] = []; - resp.forEach((batchResponse) => { + searchSubscription$.current = from(fieldStatsToFetch) + .pipe(mergeMap((observable) => observable, MAX_CONCURRENT_REQUESTS)) + .subscribe({ + next: (batchResponse) => { + setFetchState({ + ...getInitialProgress(), + error: undefined, + }); + + if (batchResponse) { + const failedFields: Field[] = []; if (Array.isArray(batchResponse)) { batchResponse.forEach((f) => { if (f.fieldName !== undefined) { - statsMap.set(f.fieldName, f); + statsMapTmp.set(f.fieldName, f); } }); } else { @@ -202,23 +234,22 @@ export function useFieldStatsSearchStrategy( // retry each field in the failed batch individually failedFields.push(...(batchResponse.fields ?? [])); } - }); - setFetchState({ - loaded: (statsMap.size / sortedConfigs.length) * 100, - isRunning: true, - }); + setFieldStats(statsMapTmp); + setFetchState({ + loaded: (statsMapTmp.size / pageOfConfigs.length) * 100, + isRunning: true, + }); - setFieldStats(statsMap); - if (failedFields.length > 0) { - statsMap$.next(statsMap); - fieldsToRetry$.next(failedFields); + if (failedFields.length > 0) { + statsMap$.next(statsMapTmp); + fieldsToRetry$.next(failedFields); + } } - } - }, - error: onError, - complete: onComplete, - }); + }, + error: onError, + complete: onComplete, + }); // If any of batches failed, retry each of the failed field at least one time individually retries$.current = combineLatest([ @@ -247,7 +278,7 @@ export function useFieldStatsSearchStrategy( }); setFieldStats(statsMap); setFetchState({ - loaded: (statsMap.size / sortedConfigs.length) * 100, + loaded: (statsMap.size / pageOfConfigs.length) * 100, isRunning: true, }); } @@ -256,7 +287,15 @@ export function useFieldStatsSearchStrategy( complete: onComplete, }); // eslint-disable-next-line react-hooks/exhaustive-deps - }, [data.search, toasts, fieldStatsParams, initialDataVisualizerListState]); + }, [ + data.search, + toasts, + fieldStatsParams, + dataVisualizerListState.pageSize, + dataVisualizerListState.pageIndex, + dataVisualizerListState.sortDirection, + dataVisualizerListState.sortField, + ]); const cancelFetch = useCallback(() => { searchSubscription$.current?.unsubscribe(); diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_overall_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_overall_stats.ts index 8995a6adc4d46a..0ad8ec70371537 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_overall_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_overall_stats.ts @@ -6,8 +6,8 @@ */ import { useCallback, useEffect, useState, useRef, useMemo, useReducer } from 'react'; -import { forkJoin, of, Subscription } from 'rxjs'; -import { switchMap } from 'rxjs/operators'; +import { from, of, Subscription, Observable } from 'rxjs'; +import { mergeMap, last, map, toArray } from 'rxjs/operators'; import { i18n } from '@kbn/i18n'; import type { ToastsStart } from 'kibana/public'; import { chunk } from 'lodash'; @@ -16,6 +16,7 @@ import { AggregatableFieldOverallStats, checkAggregatableFieldsExistRequest, checkNonAggregatableFieldExistsRequest, + isAggregatableFieldOverallStats, processAggregatableFieldsExistResponse, processNonAggregatableFieldsExistResponse, } from '../search_strategy/requests/overall_stats'; @@ -36,6 +37,31 @@ import { processDocumentCountStats, } from '../search_strategy/requests/get_document_stats'; import { getInitialProgress, getReducer } from '../progress_utils'; +import { MAX_CONCURRENT_REQUESTS } from '../constants/index_data_visualizer_viewer'; + +/** + * Helper function to run forkJoin + * with restrictions on how many input observables can be subscribed to concurrently + */ +export function rateLimitingForkJoin( + observables: Array>, + maxConcurrentRequests = MAX_CONCURRENT_REQUESTS +): Observable { + return from(observables).pipe( + mergeMap( + (observable, index) => + observable.pipe( + last(), + map((value) => ({ index, value })) + ), + maxConcurrentRequests + ), + toArray(), + map((indexedObservables) => + indexedObservables.sort((l, r) => l.index - r.index).map((obs) => obs.value) + ) + ); +} function displayError(toastNotifications: ToastsStart, index: string, err: any) { if (err.statusCode === 500) { @@ -116,72 +142,63 @@ export function useOverallStats 0 - ? forkJoin( - nonAggregatableFields.map((fieldName: string) => - data.search - .search( - { - params: checkNonAggregatableFieldExistsRequest( - index, - searchQuery, - fieldName, - timeFieldName, - earliest, - latest, - runtimeFieldMap - ), - }, - searchOptions - ) - .pipe( - switchMap((resp) => { - return of({ - ...resp, - rawResponse: { ...resp.rawResponse, fieldName }, - } as IKibanaSearchResponse); - }) - ) - ) - ) - : of(undefined); + + const nonAggregatableFieldsObs = nonAggregatableFields.map((fieldName: string) => + data.search + .search( + { + params: checkNonAggregatableFieldExistsRequest( + index, + searchQuery, + fieldName, + timeFieldName, + earliest, + latest, + runtimeFieldMap + ), + }, + searchOptions + ) + .pipe( + map((resp) => { + return { + ...resp, + rawResponse: { ...resp.rawResponse, fieldName }, + } as IKibanaSearchResponse; + }) + ) + ); // Have to divide into smaller requests to avoid 413 payload too large const aggregatableFieldsChunks = chunk(aggregatableFields, 30); - const aggregatableOverallStats$ = forkJoin( - aggregatableFields.length > 0 - ? aggregatableFieldsChunks.map((aggregatableFieldsChunk) => - data.search - .search( - { - params: checkAggregatableFieldsExistRequest( - index, - searchQuery, - aggregatableFieldsChunk, - samplerShardSize, - timeFieldName, - earliest, - latest, - undefined, - runtimeFieldMap - ), - }, - searchOptions - ) - .pipe( - switchMap((resp) => { - return of({ - ...resp, - aggregatableFields: aggregatableFieldsChunk, - } as AggregatableFieldOverallStats); - }) - ) - ) - : of(undefined) + const aggregatableOverallStatsObs = aggregatableFieldsChunks.map((aggregatableFieldsChunk) => + data.search + .search( + { + params: checkAggregatableFieldsExistRequest( + index, + searchQuery, + aggregatableFieldsChunk, + samplerShardSize, + timeFieldName, + earliest, + latest, + undefined, + runtimeFieldMap + ), + }, + searchOptions + ) + .pipe( + map((resp) => { + return { + ...resp, + aggregatableFields: aggregatableFieldsChunk, + } as AggregatableFieldOverallStats; + }) + ) ); - const documentCountStats$ = !fieldsToFetch && timeFieldName !== undefined && intervalMs !== undefined && intervalMs > 0 ? data.search.search( @@ -191,28 +208,42 @@ export function useOverallStats { + + const sub = rateLimitingForkJoin< + AggregatableFieldOverallStats | IKibanaSearchResponse | undefined + >( + [documentCountStats$, ...aggregatableOverallStatsObs, ...nonAggregatableFieldsObs], + MAX_CONCURRENT_REQUESTS + ); + + searchSubscription$.current = sub.subscribe({ + next: (value) => { + { + const aggregatableOverallStatsResp: AggregatableFieldOverallStats[] = []; + const nonAggregatableOverallStatsResp: IKibanaSearchResponse[] = []; + const documentCountStatsResp = value[0]; + + value.forEach((resp, idx) => { + if (!resp) return; + if (isAggregatableFieldOverallStats(resp)) { + aggregatableOverallStatsResp.push(resp); + } else { + nonAggregatableOverallStatsResp.push(resp); + } + }); + const aggregatableOverallStats = processAggregatableFieldsExistResponse( aggregatableOverallStatsResp, aggregatableFields, samplerShardSize ); + const nonAggregatableOverallStats = processNonAggregatableFieldsExistResponse( nonAggregatableOverallStatsResp, nonAggregatableFields ); - return of({ + setOverallStats({ documentCountStats: processDocumentCountStats( documentCountStatsResp?.rawResponse, searchStrategyParams @@ -221,14 +252,6 @@ export function useOverallStats { - if (overallStats) { - setOverallStats(overallStats); - } }, error: (error) => { displayError(toasts, searchStrategyParams.index, extractErrorProperties(error)); diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts index 1e7c99ce254283..a96244ece334af 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts @@ -90,6 +90,13 @@ export const checkAggregatableFieldsExistRequest = ( export interface AggregatableFieldOverallStats extends IKibanaSearchResponse { aggregatableFields: string[]; } + +export function isAggregatableFieldOverallStats( + arg: unknown +): arg is AggregatableFieldOverallStats { + return isPopulatedObject(arg, ['aggregatableFields']); +} + export const processAggregatableFieldsExistResponse = ( responses: AggregatableFieldOverallStats[] | undefined, aggregatableFields: string[], diff --git a/x-pack/plugins/enterprise_search/common/types/indices.ts b/x-pack/plugins/enterprise_search/common/types/indices.ts index a0be781638fb5f..61d61b73b6a452 100644 --- a/x-pack/plugins/enterprise_search/common/types/indices.ts +++ b/x-pack/plugins/enterprise_search/common/types/indices.ts @@ -19,5 +19,4 @@ export interface ElasticsearchIndex { size_in_bytes: string; }; }; - aliases: string | string[]; } diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_source.test.tsx b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_source.test.tsx index d4b5a1dbd98297..e9cbafd01003e4 100644 --- a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_source.test.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_source.test.tsx @@ -52,6 +52,7 @@ describe('AddSourceList', () => { dataLoading: false, newCustomSource: {}, isOrganization: true, + externalConfigured: false, }; beforeEach(() => { @@ -72,6 +73,17 @@ describe('AddSourceList', () => { expect(setAddSourceStep).toHaveBeenCalledWith(AddSourceSteps.SaveConfigStep); }); + it('renders default state correctly when there are multiple connector options, but all connectors have been configured', () => { + setMockValues({ ...mockValues, externalConfigured: true }); + const sourceData = { + ...staticSourceData[0], + externalConnectorAvailable: true, + configured: true, + }; + shallow(); + expect(initializeAddSource).toHaveBeenCalledWith(expect.objectContaining({ connect: true })); + }); + it('renders default state correctly when there are multiple connector options', () => { const wrapper = shallow( = (props) => { const { initializeAddSource, setAddSourceStep, saveSourceConfig, resetSourceState } = useActions(AddSourceLogic); const { addSourceCurrentStep, sourceConfigData, dataLoading } = useValues(AddSourceLogic); - const { name, categories, needsPermissions, accountContextOnly, privateSourcesEnabled } = - sourceConfigData; - const { serviceType, configuration, features, objTypes } = props.sourceData; + const { + name, + categories, + needsPermissions, + accountContextOnly, + privateSourcesEnabled, + configured, + } = sourceConfigData; + const { serviceType, configuration, features, objTypes, externalConnectorAvailable } = + props.sourceData; const addPath = getAddPath(serviceType); const { isOrganization } = useValues(AppLogic); const { externalConfigured } = useValues(SourcesLogic); useEffect(() => { - initializeAddSource(props); + // We can land on this page from a choice page for multiple types of connectors + // If that's the case we want to skip the intro and configuration, if the external & internal connector have already been configured + const goToConnect = externalConnectorAvailable && externalConfigured && configured; + initializeAddSource(goToConnect ? props : { ...props, connect: true }); return resetSourceState; }, []); diff --git a/x-pack/plugins/enterprise_search/server/lib/fetch_indices.test.ts b/x-pack/plugins/enterprise_search/server/lib/fetch_indices.test.ts index c983df7241e0a6..6bf95487a0022c 100644 --- a/x-pack/plugins/enterprise_search/server/lib/fetch_indices.test.ts +++ b/x-pack/plugins/enterprise_search/server/lib/fetch_indices.test.ts @@ -70,7 +70,6 @@ describe('fetchIndices lib function', () => { size_in_bytes: '105.47kb', }, }, - aliases: 'none', name: 'search-regular-index', }, ]); @@ -120,8 +119,22 @@ describe('fetchIndices lib function', () => { size_in_bytes: '105.47kb', }, }, - aliases: ['search-aliased', 'search-double-aliased'], - name: 'index-without-prefix', + name: 'search-aliased', + }, + { + health: 'green', + status: 'open', + uuid: '83a81e7e-5955-4255-b008-5d6961203f57', + total: { + docs: { + count: 100, + deleted: 0, + }, + store: { + size_in_bytes: '105.47kb', + }, + }, + name: 'search-double-aliased', }, ]); }); @@ -139,7 +152,6 @@ describe('fetchIndices lib function', () => { // deleted index won't be present in the indices stats call response await expect(fetchIndices(mockClient as unknown as IScopedClusterClient)).resolves.toEqual([ { - aliases: 'none', name: 'search-regular-index', total: { docs: { diff --git a/x-pack/plugins/enterprise_search/server/lib/fetch_indices.ts b/x-pack/plugins/enterprise_search/server/lib/fetch_indices.ts index 770b967bf7fb3e..4b8c2612f6467c 100644 --- a/x-pack/plugins/enterprise_search/server/lib/fetch_indices.ts +++ b/x-pack/plugins/enterprise_search/server/lib/fetch_indices.ts @@ -13,6 +13,7 @@ import { ElasticsearchIndex } from '../../common/types'; export const fetchIndices = async (client: IScopedClusterClient): Promise => { const indexNamesString = 'search-*'; + const indexNamesRegEx = /^search-*/; // This call retrieves alias and settings information about indices const indices = await client.asCurrentUser.indices.get({ @@ -36,31 +37,43 @@ export const fetchIndices = async (client: IScopedClusterClient): Promise { - const indexData = indices[indexName]; - const indexStats = indicesStats[indexName]; - const aliases = Object.keys(indexData.aliases!); - const sizeInBytes = new ByteSizeValue(indexStats?.total?.store?.size_in_bytes ?? 0).toString(); + return indicesNames + .map((indexName: string) => { + const indexData = indices[indexName]; + const indexStats = indicesStats[indexName]; + const aliases = Object.keys(indexData.aliases!); + const sizeInBytes = new ByteSizeValue( + indexStats?.total?.store?.size_in_bytes ?? 0 + ).toString(); - const docCount = indexStats?.total?.docs?.count ?? 0; - const docDeleted = indexStats?.total?.docs?.deleted ?? 0; - const total = { - docs: { - count: docCount, - deleted: docDeleted, - }, - store: { - size_in_bytes: sizeInBytes, - }, - }; + const docCount = indexStats?.total?.docs?.count ?? 0; + const docDeleted = indexStats?.total?.docs?.deleted ?? 0; + const total = { + docs: { + count: docCount, + deleted: docDeleted, + }, + store: { + size_in_bytes: sizeInBytes, + }, + }; - return { - health: indexStats?.health, - status: indexStats?.status, - name: indexName, - uuid: indexStats?.uuid, - total, - aliases: aliases.length ? aliases : 'none', - }; - }); + return { + health: indexStats?.health, + status: indexStats?.status, + name: indexName, + uuid: indexStats?.uuid, + total, + aliases, + }; + }) + .flatMap(({ name, aliases, ...engineData }) => { + const engines = []; + engines.push({ name, ...engineData }); + aliases.forEach((alias) => { + engines.push({ name: alias, ...engineData }); + }); + return engines; + }) + .filter(({ name }) => name.match(indexNamesRegEx)); }; diff --git a/x-pack/plugins/event_log/generated/mappings.json b/x-pack/plugins/event_log/generated/mappings.json index 3187423e91b29a..f030f0d50b5e73 100644 --- a/x-pack/plugins/event_log/generated/mappings.json +++ b/x-pack/plugins/event_log/generated/mappings.json @@ -296,6 +296,9 @@ "number_of_triggered_actions": { "type": "long" }, + "number_of_scheduled_actions": { + "type": "long" + }, "number_of_searches": { "type": "long" }, diff --git a/x-pack/plugins/event_log/generated/schemas.ts b/x-pack/plugins/event_log/generated/schemas.ts index 5a26cb92c636c5..817c545b45c561 100644 --- a/x-pack/plugins/event_log/generated/schemas.ts +++ b/x-pack/plugins/event_log/generated/schemas.ts @@ -130,6 +130,7 @@ export const EventSchema = schema.maybe( metrics: schema.maybe( schema.object({ number_of_triggered_actions: ecsNumber(), + number_of_scheduled_actions: ecsNumber(), number_of_searches: ecsNumber(), total_indexing_duration_ms: ecsNumber(), es_search_duration_ms: ecsNumber(), diff --git a/x-pack/plugins/event_log/scripts/mappings.js b/x-pack/plugins/event_log/scripts/mappings.js index cc255c2b15719f..bf3f9c6b88009e 100644 --- a/x-pack/plugins/event_log/scripts/mappings.js +++ b/x-pack/plugins/event_log/scripts/mappings.js @@ -78,6 +78,9 @@ exports.EcsCustomPropertyMappings = { number_of_triggered_actions: { type: 'long', }, + number_of_scheduled_actions: { + type: 'long', + }, number_of_searches: { type: 'long', }, diff --git a/x-pack/plugins/observability/common/index.ts b/x-pack/plugins/observability/common/index.ts index 3f31eb5f9140cc..1ca110f40bdbf6 100644 --- a/x-pack/plugins/observability/common/index.ts +++ b/x-pack/plugins/observability/common/index.ts @@ -15,6 +15,7 @@ export { enableComparisonByDefault, enableInfrastructureView, defaultApmServiceEnvironment, + apmServiceInventoryOptimizedSorting, } from './ui_settings_keys'; export const casesFeatureId = 'observabilityCases'; diff --git a/x-pack/plugins/observability/common/ui_settings_keys.ts b/x-pack/plugins/observability/common/ui_settings_keys.ts index b1328aec7420b3..54eaa9046d874b 100644 --- a/x-pack/plugins/observability/common/ui_settings_keys.ts +++ b/x-pack/plugins/observability/common/ui_settings_keys.ts @@ -11,3 +11,5 @@ export const enableComparisonByDefault = 'observability:enableComparisonByDefaul export const enableInfrastructureView = 'observability:enableInfrastructureView'; export const defaultApmServiceEnvironment = 'observability:apmDefaultServiceEnvironment'; export const enableServiceGroups = 'observability:enableServiceGroups'; +export const apmServiceInventoryOptimizedSorting = + 'observability:apmServiceInventoryOptimizedSorting'; diff --git a/x-pack/plugins/observability/server/ui_settings.ts b/x-pack/plugins/observability/server/ui_settings.ts index db6bc3041fe348..60dcc1384aa225 100644 --- a/x-pack/plugins/observability/server/ui_settings.ts +++ b/x-pack/plugins/observability/server/ui_settings.ts @@ -16,6 +16,7 @@ import { enableInfrastructureView, defaultApmServiceEnvironment, enableServiceGroups, + apmServiceInventoryOptimizedSorting, } from '../common/ui_settings_keys'; const technicalPreviewLabel = i18n.translate( @@ -98,4 +99,22 @@ export const uiSettings: Record[${technicalPreviewLabel}]` }, + } + ), + schema: schema.boolean(), + value: false, + requiresPageReload: false, + type: 'boolean', + }, }; diff --git a/x-pack/plugins/security_solution/common/constants.ts b/x-pack/plugins/security_solution/common/constants.ts index 91545e25057d7a..f205c6c439dc9a 100644 --- a/x-pack/plugins/security_solution/common/constants.ts +++ b/x-pack/plugins/security_solution/common/constants.ts @@ -440,3 +440,6 @@ export const RULES_TABLE_PAGE_SIZE_OPTIONS = [5, 10, 20, 50, RULES_TABLE_MAX_PAG */ export const RULES_MANAGEMENT_FEATURE_TOUR_STORAGE_KEY = 'securitySolution.rulesManagementPage.newFeaturesTour.v8.1'; + +export const RULE_DETAILS_EXECUTION_LOG_TABLE_SHOW_METRIC_COLUMNS_STORAGE_KEY = + 'securitySolution.ruleDetails.ruleExecutionLog.showMetrics.v8.2'; diff --git a/x-pack/plugins/security_solution/common/cti/constants.ts b/x-pack/plugins/security_solution/common/cti/constants.ts index 9dbeffed6e8ab1..3ea8a900b27dc8 100644 --- a/x-pack/plugins/security_solution/common/cti/constants.ts +++ b/x-pack/plugins/security_solution/common/cti/constants.ts @@ -63,3 +63,5 @@ export const DEFAULT_EVENT_ENRICHMENT_TO = 'now'; export const TI_INTEGRATION_PREFIX = 'ti'; export const OTHER_TI_DATASET_KEY = '_others_ti_'; + +export const THREAT_PIT_KEEP_ALIVE = '5m'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/rule_monitoring.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/common/rule_monitoring.ts index 6fd792c44ae962..19369ca32f4156 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/rule_monitoring.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/schemas/common/rule_monitoring.ts @@ -106,3 +106,31 @@ export const ruleExecutionEvent = t.type({ }); export type RuleExecutionEvent = t.TypeOf; + +// ------------------------------------------------------------------------------------------------- +// Aggregate Rule execution events + +export const aggregateRuleExecutionEvent = t.type({ + execution_uuid: t.string, + timestamp: IsoDateString, + duration_ms: t.number, + status: t.string, + message: t.string, + num_active_alerts: t.number, + num_new_alerts: t.number, + num_recovered_alerts: t.number, + num_triggered_actions: t.number, + num_succeeded_actions: t.number, + num_errored_actions: t.number, + total_search_duration_ms: t.number, + es_search_duration_ms: t.number, + schedule_delay_ms: t.number, + timed_out: t.boolean, + indexing_duration_ms: t.number, + search_duration_ms: t.number, + gap_duration_ms: t.number, + security_status: t.string, + security_message: t.string, +}); + +export type AggregateRuleExecutionEvent = t.TypeOf; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_rule_execution_events_request.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_rule_execution_events_schema.ts similarity index 51% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_rule_execution_events_request.ts rename to x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_rule_execution_events_schema.ts index 5e0e63ae7330dc..798e9abb5adecb 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_rule_execution_events_request.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_rule_execution_events_schema.ts @@ -7,12 +7,27 @@ import * as t from 'io-ts'; +import { sortFieldOrUndefined, sortOrderOrUndefined } from '../common'; + export const GetRuleExecutionEventsRequestParams = t.exact( t.type({ ruleId: t.string, }) ); +export const GetRuleExecutionEventsQueryParams = t.exact( + t.type({ + start: t.string, + end: t.string, + query_text: t.union([t.string, t.undefined]), + status_filters: t.union([t.string, t.undefined]), + per_page: t.union([t.string, t.undefined]), + page: t.union([t.string, t.undefined]), + sort_field: sortFieldOrUndefined, + sort_order: sortOrderOrUndefined, + }) +); + export type GetRuleExecutionEventsRequestParams = t.TypeOf< typeof GetRuleExecutionEventsRequestParams >; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/get_rule_execution_events_response.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/response/get_rule_execution_events_response.ts index 9a732a46cbaba8..dd1a8dd9d00ec0 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/get_rule_execution_events_response.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/schemas/response/get_rule_execution_events_response.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { ruleExecutionEvent } from '../common'; +import { aggregateRuleExecutionEvent, ruleExecutionEvent } from '../common'; export const GetRuleExecutionEventsResponse = t.exact( t.type({ @@ -15,3 +15,14 @@ export const GetRuleExecutionEventsResponse = t.exact( ); export type GetRuleExecutionEventsResponse = t.TypeOf; + +export const GetAggregateRuleExecutionEventsResponse = t.exact( + t.type({ + events: t.array(aggregateRuleExecutionEvent), + total: t.number, + }) +); + +export type GetAggregateRuleExecutionEventsResponse = t.TypeOf< + typeof GetAggregateRuleExecutionEventsResponse +>; diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/__mocks__/api.ts b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/__mocks__/api.ts index 0922c4b3b78b70..d93d667f5fbca1 100644 --- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/__mocks__/api.ts +++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/__mocks__/api.ts @@ -5,9 +5,8 @@ * 2.0. */ -import { RuleExecutionStatus } from '../../../../../../common/detection_engine/schemas/common'; import { - GetRuleExecutionEventsResponse, + GetAggregateRuleExecutionEventsResponse, RulesSchema, } from '../../../../../../common/detection_engine/schemas/response'; @@ -62,19 +61,44 @@ export const fetchRules = async (_: FetchRulesProps): Promise => { +}): Promise => { return Promise.resolve({ events: [ { - date: '2021-12-29T10:42:59.996Z', - status: RuleExecutionStatus.succeeded, - message: 'Rule executed successfully', + duration_ms: 3866, + es_search_duration_ms: 1236, + execution_uuid: '88d15095-7937-462c-8f21-9763e1387cad', + gap_duration_ms: 0, + indexing_duration_ms: 95, + message: + "rule executed: siem.queryRule:fb1fc150-a292-11ec-a2cf-c1b28b0392b0: 'Lots of Execution Events'", + num_active_alerts: 0, + num_errored_actions: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_succeeded_actions: 1, + num_triggered_actions: 1, + schedule_delay_ms: -127535, + search_duration_ms: 1255, + security_message: 'succeeded', + security_status: 'succeeded', + status: 'success', + timed_out: false, + timestamp: '2022-03-13T06:04:05.838Z', + total_search_duration_ms: 0, }, ], + total: 1, }); }; diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/api.test.ts b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/api.test.ts index ecfa98bfa30763..16613d7cb4d0f1 100644 --- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/api.test.ts +++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/api.test.ts @@ -595,19 +595,43 @@ describe('Detections Rules API', () => { }); test('calls API with correct parameters', async () => { - await fetchRuleExecutionEvents({ ruleId: '42', signal: abortCtrl.signal }); + await fetchRuleExecutionEvents({ + ruleId: '42', + start: '2001-01-01T17:00:00.000Z', + end: '2001-01-02T17:00:00.000Z', + queryText: '', + statusFilters: '', + signal: abortCtrl.signal, + }); expect(fetchMock).toHaveBeenCalledWith( '/internal/detection_engine/rules/42/execution/events', { method: 'GET', + query: { + end: '2001-01-02T17:00:00.000Z', + page: undefined, + per_page: undefined, + query_text: '', + sort_field: undefined, + sort_order: undefined, + start: '2001-01-01T17:00:00.000Z', + status_filters: '', + }, signal: abortCtrl.signal, } ); }); test('returns API response as is', async () => { - const response = await fetchRuleExecutionEvents({ ruleId: '42', signal: abortCtrl.signal }); + const response = await fetchRuleExecutionEvents({ + ruleId: '42', + start: 'now-30', + end: 'now', + queryText: '', + statusFilters: '', + signal: abortCtrl.signal, + }); expect(response).toEqual(responseMock); }); }); diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/api.ts b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/api.ts index 5b29671d05bac5..5006d6390f45ab 100644 --- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/api.ts +++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/api.ts @@ -6,6 +6,7 @@ */ import { camelCase } from 'lodash'; +import dateMath from '@elastic/datemath'; import { HttpStart } from 'src/core/public'; import { @@ -24,7 +25,7 @@ import { } from '../../../../../common/detection_engine/schemas/request'; import { RulesSchema, - GetRuleExecutionEventsResponse, + GetAggregateRuleExecutionEventsResponse, } from '../../../../../common/detection_engine/schemas/response'; import { @@ -315,21 +316,57 @@ export const exportRules = async ({ /** * Fetch rule execution events (e.g. status changes) from Event Log. * - * @param ruleId string Saved Object ID of the rule (`rule.id`, not static `rule.rule_id`) + * @param ruleId Saved Object ID of the rule (`rule.id`, not static `rule.rule_id`) + * @param start Start daterange either in UTC ISO8601 or as datemath string (e.g. `2021-12-29T02:44:41.653Z` or `now-30`) + * @param end End daterange either in UTC ISO8601 or as datemath string (e.g. `2021-12-29T02:44:41.653Z` or `now/w`) + * @param queryText search string in querystring format (e.g. `event.duration > 1000 OR kibana.alert.rule.execution.metrics.execution_gap_duration_s > 100`) + * @param statusFilters comma separated string of `statusFilters` (e.g. `succeeded,failed,partial failure`) + * @param page current page to fetch + * @param perPage number of results to fetch per page + * @param sortField field to sort by + * @param sortOrder what order to sort by (e.g. `asc` or `desc`) * @param signal AbortSignal Optional signal for cancelling the request * * @throws An error if response is not OK */ export const fetchRuleExecutionEvents = async ({ ruleId, + start, + end, + queryText, + statusFilters, + page, + perPage, + sortField, + sortOrder, signal, }: { ruleId: string; + start: string; + end: string; + queryText?: string; + statusFilters?: string; + page?: number; + perPage?: number; + sortField?: string; + sortOrder?: string; signal?: AbortSignal; -}): Promise => { +}): Promise => { const url = detectionEngineRuleExecutionEventsUrl(ruleId); - return KibanaServices.get().http.fetch(url, { + const startDate = dateMath.parse(start); + const endDate = dateMath.parse(end, { roundUp: true }); + return KibanaServices.get().http.fetch(url, { method: 'GET', + query: { + start: startDate?.utc().toISOString(), + end: endDate?.utc().toISOString(), + query_text: queryText?.trim(), + status_filters: statusFilters?.trim(), + page, + per_page: perPage, + sort_field: sortField, + sort_order: sortOrder, + }, signal, }); }; diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/translations.ts b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/translations.ts index 86107a4019b0a5..5d2bac9e8b5014 100644 --- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/translations.ts +++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/translations.ts @@ -14,6 +14,13 @@ export const RULE_AND_TIMELINE_FETCH_FAILURE = i18n.translate( } ); +export const RULE_EXECUTION_FETCH_FAILURE = i18n.translate( + 'xpack.securitySolution.containers.detectionEngine.ruleExecutionLogFailureDescription', + { + defaultMessage: 'Failed to fetch Rule Execution Events', + } +); + export const RULE_ADD_FAILURE = i18n.translate( 'xpack.securitySolution.containers.detectionEngine.addRuleFailDescription', { diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_execution_events.test.tsx b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_execution_events.test.tsx index 4a98110153830b..2a4efb7f69491c 100644 --- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_execution_events.test.tsx +++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_execution_events.test.tsx @@ -12,7 +12,6 @@ import React from 'react'; import { QueryClient, QueryClientProvider } from 'react-query'; import { renderHook, cleanup } from '@testing-library/react-hooks'; -import { RuleExecutionStatus } from '../../../../../common/detection_engine/schemas/common'; import { useRuleExecutionEvents } from './use_rule_execution_events'; import * as api from './api'; @@ -45,9 +44,19 @@ describe('useRuleExecutionEvents', () => { }; const render = () => - renderHook(() => useRuleExecutionEvents(SOME_RULE_ID), { - wrapper: createReactQueryWrapper(), - }); + renderHook( + () => + useRuleExecutionEvents({ + ruleId: SOME_RULE_ID, + start: 'now-30', + end: 'now', + queryText: '', + statusFilters: '', + }), + { + wrapper: createReactQueryWrapper(), + } + ); it('calls the API via fetchRuleExecutionEvents', async () => { const fetchRuleExecutionEvents = jest.spyOn(api, 'fetchRuleExecutionEvents'); @@ -77,13 +86,34 @@ describe('useRuleExecutionEvents', () => { expect(result.current.isLoading).toEqual(false); expect(result.current.isSuccess).toEqual(true); expect(result.current.isError).toEqual(false); - expect(result.current.data).toEqual([ - { - date: '2021-12-29T10:42:59.996Z', - status: RuleExecutionStatus.succeeded, - message: 'Rule executed successfully', - }, - ]); + expect(result.current.data).toEqual({ + events: [ + { + duration_ms: 3866, + es_search_duration_ms: 1236, + execution_uuid: '88d15095-7937-462c-8f21-9763e1387cad', + gap_duration_ms: 0, + indexing_duration_ms: 95, + message: + "rule executed: siem.queryRule:fb1fc150-a292-11ec-a2cf-c1b28b0392b0: 'Lots of Execution Events'", + num_active_alerts: 0, + num_errored_actions: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_succeeded_actions: 1, + num_triggered_actions: 1, + schedule_delay_ms: -127535, + search_duration_ms: 1255, + security_message: 'succeeded', + security_status: 'succeeded', + status: 'success', + timed_out: false, + timestamp: '2022-03-13T06:04:05.838Z', + total_search_duration_ms: 0, + }, + ], + total: 1, + }); }); it('handles exceptions from the API', async () => { diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_execution_events.tsx b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_execution_events.tsx index 58f4c524dc3620..33b965cab979f6 100644 --- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_execution_events.tsx +++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_execution_events.tsx @@ -6,18 +6,62 @@ */ import { useQuery } from 'react-query'; +import { GetAggregateRuleExecutionEventsResponse } from '../../../../../common/detection_engine/schemas/response'; import { useAppToasts } from '../../../../common/hooks/use_app_toasts'; import { fetchRuleExecutionEvents } from './api'; import * as i18n from './translations'; -export const useRuleExecutionEvents = (ruleId: string) => { +interface UseRuleExecutionEventsArgs { + ruleId: string; + start: string; + end: string; + queryText?: string; + statusFilters?: string; + page?: number; + perPage?: number; + sortField?: string; + sortOrder?: string; +} + +export const useRuleExecutionEvents = ({ + ruleId, + start, + end, + queryText, + statusFilters, + page, + perPage, + sortField, + sortOrder, +}: UseRuleExecutionEventsArgs) => { const { addError } = useAppToasts(); - return useQuery( - ['ruleExecutionEvents', ruleId], + return useQuery( + [ + 'ruleExecutionEvents', + ruleId, + start, + end, + queryText, + statusFilters, + page, + perPage, + sortField, + sortOrder, + ], async ({ signal }) => { - const response = await fetchRuleExecutionEvents({ ruleId, signal }); - return response.events; + return fetchRuleExecutionEvents({ + ruleId, + start, + end, + queryText, + statusFilters, + page, + perPage, + sortField, + sortOrder, + signal, + }); }, { onError: (e) => { diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/popover_tooltip.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/popover_tooltip.tsx index 22bad4fffade97..564f73c379c635 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/popover_tooltip.tsx +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/popover_tooltip.tsx @@ -30,7 +30,10 @@ const PopoverTooltipComponent = ({ columnName, children }: PopoverTooltipProps) button={ setIsPopoverOpen(!isPopoverOpen)} + onClick={(event: React.MouseEvent) => { + setIsPopoverOpen(!isPopoverOpen); + event.stopPropagation(); + }} size="xs" color="primary" iconType="questionInCircle" diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/use_columns.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/use_columns.tsx index 5882cc9a72d9a4..a6891af1cc7dac 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/use_columns.tsx +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/use_columns.tsx @@ -346,7 +346,7 @@ export const useMonitoringColumns = ({ hasPermissions }: ColumnsProps): TableCol href={`${docLinks.links.siem.troubleshootGaps}`} target="_blank" > - {'see documentation'} + {i18n.COLUMN_GAP_TOOLTIP_SEE_DOCUMENTATION} ), }} diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/execution_log_search_bar.test.tsx.snap b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/execution_log_search_bar.test.tsx.snap new file mode 100644 index 00000000000000..a4e8e2cf6e9bdf --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/execution_log_search_bar.test.tsx.snap @@ -0,0 +1,78 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`ExecutionLogSearchBar snapshots renders correctly against snapshot 1`] = ` + + + + + + Status + + } + closePopover={[Function]} + display="inlineBlock" + hasArrow={true} + isOpen={false} + ownFocus={true} + panelPaddingSize="none" + repositionOnScroll={true} + > + + + Succeeded + + + + + Failed + + + + + Partial failure + + + + + + +`; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/execution_log_table.test.tsx.snap b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/execution_log_table.test.tsx.snap new file mode 100644 index 00000000000000..fdec953b833e61 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/execution_log_table.test.tsx.snap @@ -0,0 +1,210 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`ExecutionLogTable snapshots renders correctly against snapshot 1`] = ` + + + + + + + + + + + + + + + Showing 0 rule executions + + + + + + + + + , + "render": [Function], + "sortable": false, + "truncateText": false, + "width": "10%", + }, + Object { + "field": "timestamp", + "name": , + "render": [Function], + "sortable": true, + "truncateText": false, + "width": "15%", + }, + Object { + "field": "duration_ms", + "name": , + "render": [Function], + "sortable": true, + "truncateText": false, + "width": "10%", + }, + Object { + "field": "security_message", + "name": , + "render": [Function], + "sortable": false, + "truncateText": false, + "width": "35%", + }, + Object { + "actions": Array [ + Object { + "data-test-subj": "action-filter-by-execution-id", + "description": "Filter alerts by rule execution ID.", + "field": "", + "icon": "filter", + "isPrimary": true, + "name": "Edit", + "onClick": [Function], + "type": "icon", + }, + ], + "field": "kibana.alert.rule.execution.uuid", + "name": "Actions", + "width": "5%", + }, + ] + } + items={Array []} + noItemsMessage={ + + } + onChange={[Function]} + pagination={ + Object { + "pageIndex": 0, + "pageSize": 5, + "pageSizeOptions": Array [ + 5, + 10, + 25, + 50, + ], + "totalItemCount": 0, + } + } + responsive={true} + sorting={ + Object { + "sort": Object { + "direction": "desc", + "field": "timestamp", + }, + } + } + tableLayout="fixed" + /> + +`; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/rule_duration_format.test.tsx.snap b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/rule_duration_format.test.tsx.snap new file mode 100644 index 00000000000000..ddb59cf52a8903 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/__snapshots__/rule_duration_format.test.tsx.snap @@ -0,0 +1,9 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`RuleDurationFormat snapshots renders correctly against snapshot 1`] = ` + + 00:00:00:000 + +`; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_columns.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_columns.tsx new file mode 100644 index 00000000000000..5242b6dbe03134 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_columns.tsx @@ -0,0 +1,171 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { EuiBasicTableColumn, EuiHealth, EuiLink, EuiText } from '@elastic/eui'; +import { capitalize } from 'lodash'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { DocLinksStart } from 'kibana/public'; +import React from 'react'; +import { + AggregateRuleExecutionEvent, + RuleExecutionStatus, +} from '../../../../../../../common/detection_engine/schemas/common'; +import { getEmptyTagValue, getEmptyValue } from '../../../../../../common/components/empty_value'; +import { FormattedDate } from '../../../../../../common/components/formatted_date'; +import { getStatusColor } from '../../../../../components/rules/rule_execution_status/utils'; +import { PopoverTooltip } from '../../all/popover_tooltip'; +import { TableHeaderTooltipCell } from '../../all/table_header_tooltip_cell'; + +import * as i18n from './translations'; +import { RuleDurationFormat } from './rule_duration_format'; + +export const EXECUTION_LOG_COLUMNS: Array> = [ + { + name: ( + + ), + field: 'security_status', + render: (value: RuleExecutionStatus, data) => + value ? ( + {capitalize(value)} + ) : ( + getEmptyTagValue() + ), + sortable: false, + truncateText: false, + width: '10%', + }, + { + field: 'timestamp', + name: ( + + ), + render: (value: string) => , + sortable: true, + truncateText: false, + width: '15%', + }, + { + field: 'duration_ms', + name: ( + + ), + render: (value: number) => ( + <>{value ? : getEmptyValue()} + ), + sortable: true, + truncateText: false, + width: '10%', + }, + { + field: 'security_message', + name: ( + + ), + render: (value: string) => <>{value}, + sortable: false, + truncateText: false, + width: '35%', + }, +]; + +export const GET_EXECUTION_LOG_METRICS_COLUMNS = ( + docLinks: DocLinksStart +): Array> => [ + { + field: 'gap_duration_ms', + name: ( + + + +

+ + {i18n.COLUMN_GAP_TOOLTIP_SEE_DOCUMENTATION} + + ), + }} + /> +

+ + + + } + /> + ), + render: (value: number) => ( + <>{value ? : getEmptyValue()} + ), + sortable: true, + truncateText: false, + width: '10%', + }, + { + field: 'indexing_duration_ms', + name: ( + + ), + render: (value: number) => ( + <>{value ? : getEmptyValue()} + ), + sortable: true, + truncateText: false, + width: '10%', + }, + { + field: 'search_duration_ms', + name: ( + + ), + render: (value: number) => ( + <>{value ? : getEmptyValue()} + ), + sortable: true, + truncateText: false, + width: '10%', + }, + { + field: 'schedule_delay_ms', + name: ( + + ), + render: (value: number) => ( + <>{value ? : getEmptyValue()} + ), + sortable: true, + truncateText: false, + width: '10%', + }, +]; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_search_bar.test.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_search_bar.test.tsx new file mode 100644 index 00000000000000..cfa5322769940e --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_search_bar.test.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { shallow } from 'enzyme'; +import React from 'react'; +import { ExecutionLogSearchBar } from './execution_log_search_bar'; +import { noop } from 'lodash/fp'; + +// TODO: Replace snapshot test with base test cases + +describe('ExecutionLogSearchBar', () => { + describe('snapshots', () => { + test('renders correctly against snapshot', () => { + const wrapper = shallow( + + ); + expect(wrapper).toMatchSnapshot(); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_search_bar.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_search_bar.tsx new file mode 100644 index 00000000000000..2c0b18828dcbc2 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_search_bar.tsx @@ -0,0 +1,147 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useCallback, useEffect, useMemo, useState } from 'react'; +import { capitalize, replace } from 'lodash'; +import { + EuiHealth, + EuiFieldSearch, + EuiFlexGroup, + EuiFlexItem, + EuiPopover, + EuiFilterGroup, + EuiFilterButton, + EuiFilterSelectItem, +} from '@elastic/eui'; +import { RuleExecutionStatus } from '../../../../../../../common/detection_engine/schemas/common'; +import { getStatusColor } from '../../../../../components/rules/rule_execution_status/utils'; +import * as i18n from './translations'; + +export const EXECUTION_LOG_SCHEMA_MAPPING = { + status: 'kibana.alert.rule.execution.status', + timestamp: '@timestamp', + duration: 'event.duration', + message: 'message', + gapDuration: 'kibana.alert.rule.execution.metrics.execution_gap_duration_s', + indexDuration: 'kibana.alert.rule.execution.metrics.total_indexing_duration_ms', + searchDuration: 'kibana.alert.rule.execution.metrics.total_search_duration_ms', + totalActions: 'kibana.alert.rule.execution.metrics.number_of_triggered_actions', + schedulingDelay: 'kibana.task.schedule_delay', +}; + +export const replaceQueryTextAliases = (queryText: string): string => { + return Object.entries(EXECUTION_LOG_SCHEMA_MAPPING).reduce( + (updatedQuery, [key, value]) => { + return replace(updatedQuery, key, value); + }, + queryText + ); +}; + +const statuses = [ + RuleExecutionStatus.succeeded, + RuleExecutionStatus.failed, + RuleExecutionStatus['partial failure'], +]; + +const statusFilters = statuses.map((status) => ({ + label: {capitalize(status)}, + selected: false, +})); + +interface ExecutionLogTableSearchProps { + onlyShowFilters: true; + onSearch: (queryText: string) => void; + onStatusFilterChange: (statusFilters: string[]) => void; +} + +export const ExecutionLogSearchBar = React.memo( + ({ onlyShowFilters, onSearch, onStatusFilterChange }) => { + const [isPopoverOpen, setIsPopoverOpen] = useState(false); + const [selectedFilters, setSelectedFilters] = useState([]); + + const onSearchCallback = useCallback( + (queryText: string) => { + onSearch(replaceQueryTextAliases(queryText)); + }, + [onSearch] + ); + + const onStatusFilterChangeCallback = useCallback( + (filter: RuleExecutionStatus) => { + setSelectedFilters( + selectedFilters.includes(filter) + ? selectedFilters.filter((f) => f !== filter) + : [...selectedFilters, filter] + ); + }, + [selectedFilters] + ); + + const filtersComponent = useMemo(() => { + return statuses.map((filter, index) => ( + onStatusFilterChangeCallback(filter)} + title={filter} + > + {capitalize(filter)} + + )); + }, [onStatusFilterChangeCallback, selectedFilters]); + + useEffect(() => { + onStatusFilterChange(selectedFilters); + }, [onStatusFilterChange, selectedFilters]); + + return ( + + + {!onlyShowFilters && ( + + )} + + + + setIsPopoverOpen(!isPopoverOpen)} + numFilters={statusFilters.length} + isSelected={isPopoverOpen} + hasActiveFilters={selectedFilters.length > 0} + numActiveFilters={selectedFilters.length} + > + {i18n.COLUMN_STATUS} + + } + isOpen={isPopoverOpen} + closePopover={() => setIsPopoverOpen(false)} + panelPaddingSize="none" + repositionOnScroll + > + {filtersComponent} + + + + + ); + } +); + +ExecutionLogSearchBar.displayName = 'ExecutionLogSearchBar'; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_table.test.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_table.test.tsx new file mode 100644 index 00000000000000..8a3bb8621f7ae4 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_table.test.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { shallow } from 'enzyme'; +import { noop } from 'lodash/fp'; + +import { useSourcererDataView } from '../../../../../../common/containers/sourcerer'; +import { ExecutionLogTable } from './execution_log_table'; + +jest.mock('../../../../../containers/detection_engine/rules', () => { + const original = jest.requireActual('../../../../../containers/detection_engine/rules'); + return { + ...original, + useRuleExecutionEvents: jest.fn().mockReturnValue({ + loading: true, + setQuery: () => undefined, + data: null, + response: '', + request: '', + refetch: null, + }), + }; +}); + +jest.mock('../../../../../../common/containers/sourcerer'); + +jest.mock('../../../../../../common/hooks/use_app_toasts', () => { + const original = jest.requireActual('../../../../../../common/hooks/use_app_toasts'); + + return { + ...original, + useAppToasts: () => ({ + addSuccess: jest.fn(), + addError: jest.fn(), + }), + }; +}); + +jest.mock('react-redux', () => { + const original = jest.requireActual('react-redux'); + return { + ...original, + useDispatch: () => jest.fn(), + useSelector: () => jest.fn(), + }; +}); + +jest.mock('../../../../../../common/lib/kibana', () => { + const original = jest.requireActual('../../../../../../common/lib/kibana'); + + return { + ...original, + useUiSetting$: jest.fn().mockReturnValue([]), + useKibana: () => ({ + services: { + data: { + query: { + filterManager: jest.fn().mockReturnValue({}), + }, + }, + docLinks: { + links: { + siem: { + troubleshootGaps: 'link', + }, + }, + }, + storage: { + get: jest.fn(), + set: jest.fn(), + }, + timelines: { + getLastUpdated: jest.fn(), + getFieldBrowser: jest.fn(), + }, + }, + }), + }; +}); + +const mockUseSourcererDataView = useSourcererDataView as jest.Mock; +mockUseSourcererDataView.mockReturnValue({ + missingPatterns: {}, + selectedPatterns: {}, + scopeSelectedPatterns: {}, + loading: false, +}); + +// TODO: Replace snapshot test with base test cases + +describe('ExecutionLogTable', () => { + describe('snapshots', () => { + test('renders correctly against snapshot', () => { + const wrapper = shallow(); + expect(wrapper).toMatchSnapshot(); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_table.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_table.tsx new file mode 100644 index 00000000000000..212ac9ec5b94f9 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/execution_log_table.tsx @@ -0,0 +1,325 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { SortOrder } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { DurationRange } from '@elastic/eui/src/components/date_picker/types'; +import { get } from 'lodash'; +import styled from 'styled-components'; +import React, { useCallback, useMemo, useState } from 'react'; +import { + EuiTextColor, + EuiFlexGroup, + EuiFlexItem, + EuiSuperDatePicker, + OnTimeChangeProps, + OnRefreshProps, + OnRefreshChangeProps, + EuiSpacer, + EuiSwitch, + EuiBasicTable, +} from '@elastic/eui'; +import { buildFilter, FILTERS } from '@kbn/es-query'; +import { MAX_EXECUTION_EVENTS_DISPLAYED } from '@kbn/securitysolution-rules'; +import { RULE_DETAILS_EXECUTION_LOG_TABLE_SHOW_METRIC_COLUMNS_STORAGE_KEY } from '../../../../../../../common/constants'; +import { AggregateRuleExecutionEvent } from '../../../../../../../common/detection_engine/schemas/common'; + +import { + UtilityBar, + UtilityBarGroup, + UtilityBarSection, + UtilityBarText, +} from '../../../../../../common/components/utility_bar'; +import { useSourcererDataView } from '../../../../../../common/containers/sourcerer'; +import { useAppToasts } from '../../../../../../common/hooks/use_app_toasts'; +import { useKibana } from '../../../../../../common/lib/kibana'; +import { SourcererScopeName } from '../../../../../../common/store/sourcerer/model'; +import { useRuleExecutionEvents } from '../../../../../containers/detection_engine/rules'; +import * as i18n from './translations'; +import { EXECUTION_LOG_COLUMNS, GET_EXECUTION_LOG_METRICS_COLUMNS } from './execution_log_columns'; +import { ExecutionLogSearchBar } from './execution_log_search_bar'; + +const EXECUTION_UUID_FIELD_NAME = 'kibana.alert.rule.execution.uuid'; + +const UtilitySwitch = styled(EuiSwitch)` + margin-left: 17px; +`; + +interface ExecutionLogTableProps { + ruleId: string; + selectAlertsTab: () => void; +} + +const ExecutionLogTableComponent: React.FC = ({ + ruleId, + selectAlertsTab, +}) => { + const { + docLinks, + data: { + query: { filterManager }, + }, + storage, + timelines, + } = useKibana().services; + // Datepicker state + const [recentlyUsedRanges, setRecentlyUsedRanges] = useState([]); + const [refreshInterval, setRefreshInterval] = useState(1000); + const [isPaused, setIsPaused] = useState(true); + const [start, setStart] = useState('now-24h'); + const [end, setEnd] = useState('now'); + + // Searchbar/Filter/Settings state + const [queryText, setQueryText] = useState(''); + const [statusFilters, setStatusFilters] = useState(''); + const [showMetricColumns, setShowMetricColumns] = useState( + storage.get(RULE_DETAILS_EXECUTION_LOG_TABLE_SHOW_METRIC_COLUMNS_STORAGE_KEY) ?? false + ); + + // Pagination state + const [pageIndex, setPageIndex] = useState(0); + const [pageSize, setPageSize] = useState(5); + const [sortField, setSortField] = useState('timestamp'); + const [sortDirection, setSortDirection] = useState('desc'); + // Index for `add filter` action and toasts for errors + const { indexPattern } = useSourcererDataView(SourcererScopeName.detections); + const { addError } = useAppToasts(); + + // Table data state + const { + data: events, + dataUpdatedAt, + isFetching, + isLoading, + refetch, + } = useRuleExecutionEvents({ + ruleId, + start, + end, + queryText, + statusFilters, + page: pageIndex, + perPage: pageSize, + sortField, + sortOrder: sortDirection, + }); + const items = events?.events ?? []; + const maxEvents = events?.total ?? 0; + + // Callbacks + const onTableChangeCallback = useCallback(({ page = {}, sort = {} }) => { + const { index, size } = page; + const { field, direction } = sort; + + setPageIndex(index); + setPageSize(size); + setSortField(field); + setSortDirection(direction); + }, []); + + const onTimeChangeCallback = useCallback( + (props: OnTimeChangeProps) => { + const recentlyUsedRange = recentlyUsedRanges.filter((range) => { + const isDuplicate = range.start === props.start && range.end === props.end; + return !isDuplicate; + }); + recentlyUsedRange.unshift({ start: props.start, end: props.end }); + setStart(props.start); + setEnd(props.end); + setRecentlyUsedRanges( + recentlyUsedRange.length > 10 ? recentlyUsedRange.slice(0, 9) : recentlyUsedRange + ); + }, + [recentlyUsedRanges] + ); + + const onRefreshChangeCallback = useCallback((props: OnRefreshChangeProps) => { + setIsPaused(props.isPaused); + setRefreshInterval(props.refreshInterval); + }, []); + + const onRefreshCallback = useCallback( + (props: OnRefreshProps) => { + refetch(); + }, + [refetch] + ); + + const onSearchCallback = useCallback((updatedQueryText: string) => { + setQueryText(updatedQueryText); + }, []); + + const onStatusFilterChangeCallback = useCallback((updatedStatusFilters: string[]) => { + setStatusFilters(updatedStatusFilters.sort().join(',')); + }, []); + + const onFilterByExecutionIdCallback = useCallback( + (executionId: string) => { + const field = indexPattern.fields.find((f) => f.name === EXECUTION_UUID_FIELD_NAME); + if (field != null) { + const filter = buildFilter( + indexPattern, + field, + FILTERS.PHRASE, + false, + false, + executionId, + null + ); + filterManager.addFilters(filter); + selectAlertsTab(); + } else { + addError(i18n.ACTIONS_FIELD_NOT_FOUND_ERROR, { + title: i18n.ACTIONS_FIELD_NOT_FOUND_ERROR_TITLE, + }); + } + }, + [addError, filterManager, indexPattern, selectAlertsTab] + ); + + const onShowMetricColumnsCallback = useCallback( + (showMetrics: boolean) => { + storage.set(RULE_DETAILS_EXECUTION_LOG_TABLE_SHOW_METRIC_COLUMNS_STORAGE_KEY, showMetrics); + setShowMetricColumns(showMetrics); + }, + [storage] + ); + + // Memoized state + const pagination = useMemo(() => { + return { + pageIndex, + pageSize, + totalItemCount: + maxEvents > MAX_EXECUTION_EVENTS_DISPLAYED ? MAX_EXECUTION_EVENTS_DISPLAYED : maxEvents, + pageSizeOptions: [5, 10, 25, 50], + }; + }, [maxEvents, pageIndex, pageSize]); + + const sorting = useMemo(() => { + return { + sort: { + field: sortField, + direction: sortDirection, + }, + }; + }, [sortDirection, sortField]); + + const actions = useMemo( + () => [ + { + field: EXECUTION_UUID_FIELD_NAME, + name: i18n.COLUMN_ACTIONS, + width: '5%', + actions: [ + { + name: 'Edit', + isPrimary: true, + field: '', + description: i18n.COLUMN_ACTIONS_TOOLTIP, + icon: 'filter', + type: 'icon', + onClick: (value: object) => { + const executionId = get(value, EXECUTION_UUID_FIELD_NAME); + if (executionId) { + onFilterByExecutionIdCallback(executionId); + } + }, + 'data-test-subj': 'action-filter-by-execution-id', + }, + ], + }, + ], + [onFilterByExecutionIdCallback] + ); + + const executionLogColumns = useMemo( + () => + showMetricColumns + ? [...EXECUTION_LOG_COLUMNS, ...GET_EXECUTION_LOG_METRICS_COLUMNS(docLinks), ...actions] + : [...EXECUTION_LOG_COLUMNS, ...actions], + [actions, docLinks, showMetricColumns] + ); + + return ( + <> + + + + + + + + + + + + + + {i18n.SHOWING_EXECUTIONS( + maxEvents > MAX_EXECUTION_EVENTS_DISPLAYED + ? MAX_EXECUTION_EVENTS_DISPLAYED + : maxEvents + )} + + + {maxEvents > MAX_EXECUTION_EVENTS_DISPLAYED && ( + + + + {i18n.RULE_EXECUTION_LOG_SEARCH_LIMIT_EXCEEDED( + maxEvents, + MAX_EXECUTION_EVENTS_DISPLAYED + )} + + + + )} + + + + {timelines.getLastUpdated({ + showUpdating: isLoading || isFetching, + updatedAt: dataUpdatedAt, + })} + + onShowMetricColumnsCallback(e.target.checked)} + /> + + + + + ); +}; + +export const ExecutionLogTable = React.memo(ExecutionLogTableComponent); +ExecutionLogTable.displayName = 'ExecutionLogTable'; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/rule_duration_format.test.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/rule_duration_format.test.tsx new file mode 100644 index 00000000000000..44f765f934ae86 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/rule_duration_format.test.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { shallow } from 'enzyme'; +import React from 'react'; +import { RuleDurationFormat } from './rule_duration_format'; + +// TODO: Replace snapshot test with base test cases + +describe('RuleDurationFormat', () => { + describe('snapshots', () => { + test('renders correctly against snapshot', () => { + const wrapper = shallow(); + expect(wrapper).toMatchSnapshot(); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/rule_duration_format.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/rule_duration_format.tsx new file mode 100644 index 00000000000000..cdbc19ce16c3b8 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/rule_duration_format.tsx @@ -0,0 +1,55 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import numeral from '@elastic/numeral'; +import moment from 'moment'; +import React, { useMemo } from 'react'; + +interface Props { + duration: number; + isMillis?: boolean; + allowZero?: boolean; +} + +export function getFormattedDuration(value: number) { + if (!value) { + return '00:00:00:000'; + } + const duration = moment.duration(value); + const hours = Math.floor(duration.asHours()).toString().padStart(2, '0'); + const minutes = Math.floor(duration.asMinutes()).toString().padStart(2, '0'); + const seconds = duration.seconds().toString().padStart(2, '0'); + const ms = duration.milliseconds().toString().padStart(3, '0'); + return `${hours}:${minutes}:${seconds}:${ms}`; +} + +export function getFormattedMilliseconds(value: number) { + const formatted = numeral(value).format('0,0'); + return `${formatted} ms`; +} + +/** + * Formats duration as (hh:mm:ss:SSS) + * @param props duration default as nanos, set isMillis:true to pass in ms + * @constructor + */ +const RuleDurationFormatComponent = (props: Props) => { + const { duration, isMillis = false, allowZero = true } = props; + + const formattedDuration = useMemo(() => { + // Durations can be buggy and return negative + if (allowZero && duration >= 0) { + return getFormattedDuration(isMillis ? duration * 1000 : duration); + } + return 'N/A'; + }, [allowZero, duration, isMillis]); + + return {formattedDuration}; +}; + +export const RuleDurationFormat = React.memo(RuleDurationFormatComponent); +RuleDurationFormat.displayName = 'RuleDurationFormat'; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/translations.ts b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/translations.ts new file mode 100644 index 00000000000000..97ae8e42ebb618 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/execution_log_table/translations.ts @@ -0,0 +1,182 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; + +export const SHOWING_EXECUTIONS = (totalItems: number) => + i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.totalExecutionsLabel', + { + values: { totalItems }, + defaultMessage: + 'Showing {totalItems} {totalItems, plural, =1 {rule execution} other {rule executions}}', + } + ); + +export const RULE_EXECUTION_LOG_SEARCH_LIMIT_EXCEEDED = (totalItems: number, maxItems: number) => + i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.searchLimitExceededLabel', + { + values: { totalItems, maxItems }, + defaultMessage: + "More than {totalItems} rule executions match filters provided. Showing first {maxItems} by most recent '@timestamp'. Constrain filters further to view additional execution events.", + } + ); + +export const RULE_EXECUTION_LOG_SEARCH_PLACEHOLDER = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.searchPlaceholder', + { + defaultMessage: 'duration > 100 and gapDuration > 10', + } +); + +export const RULE_EXECUTION_LOG_SHOW_METRIC_COLUMNS_SWITCH = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.showMetricColumnsSwitchTitle', + { + defaultMessage: 'Show metrics columns', + } +); + +export const COLUMN_STATUS = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.statusColumn', + { + defaultMessage: 'Status', + } +); + +export const COLUMN_STATUS_TOOLTIP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.statusColumnTooltip', + { + defaultMessage: 'Overall status of execution.', + } +); + +export const COLUMN_TIMESTAMP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.timestampColumn', + { + defaultMessage: 'Timestamp', + } +); + +export const COLUMN_TIMESTAMP_TOOLTIP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.timestampColumnTooltip', + { + defaultMessage: 'Datetime rule execution initiated.', + } +); + +export const COLUMN_DURATION = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.durationColumn', + { + defaultMessage: 'Duration', + } +); + +export const COLUMN_DURATION_TOOLTIP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.durationColumnTooltip', + { + defaultMessage: 'The length of time it took for the rule to run (hh:mm:ss:SSS).', + } +); + +export const COLUMN_MESSAGE = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.messageColumn', + { + defaultMessage: 'Message', + } +); + +export const COLUMN_MESSAGE_TOOLTIP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.messageColumnTooltip', + { + defaultMessage: 'Relevant message from execution outcome.', + } +); + +export const COLUMN_GAP_DURATION = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.gapDurationColumn', + { + defaultMessage: 'Gap Duration', + } +); + +export const COLUMN_GAP_TOOLTIP_SEE_DOCUMENTATION = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.gapTooltipSeeDocsDescription', + { + defaultMessage: 'see documentation', + } +); + +export const COLUMN_INDEX_DURATION = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.indexDurationColumn', + { + defaultMessage: 'Index Duration', + } +); + +export const COLUMN_INDEX_DURATION_TOOLTIP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.indexDurationColumnTooltip', + { + defaultMessage: 'The length of time it took to index detected alerts (hh:mm:ss:SSS).', + } +); + +export const COLUMN_SEARCH_DURATION = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.searchDurationColumn', + { + defaultMessage: 'Search Duration', + } +); + +export const COLUMN_SEARCH_DURATION_TOOLTIP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.searchDurationColumnTooltip', + { + defaultMessage: 'The length of time it took to search for alerts (hh:mm:ss:SSS).', + } +); + +export const COLUMN_SCHEDULING_DELAY = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.schedulingDelayColumn', + { + defaultMessage: 'Scheduling Delay', + } +); + +export const COLUMN_SCHEDULING_DELAY_TOOLTIP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.schedulingDelayColumnTooltip', + { + defaultMessage: 'The length of time from rule scheduled till rule executed (hh:mm:ss:SSS).', + } +); + +export const COLUMN_ACTIONS = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.actionsColumn', + { + defaultMessage: 'Actions', + } +); + +export const COLUMN_ACTIONS_TOOLTIP = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.actionsColumnTooltip', + { + defaultMessage: 'Filter alerts by rule execution ID.', + } +); + +export const ACTIONS_FIELD_NOT_FOUND_ERROR_TITLE = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.actionFieldNotFoundErrorTitle', + { + defaultMessage: 'Unable to filter alerts', + } +); + +export const ACTIONS_FIELD_NOT_FOUND_ERROR = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLog.actionFieldNotFoundErrorDescription', + { + defaultMessage: "Cannot find field 'kibana.alert.rule.execution.uuid' in alerts index.", + } +); diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/failure_history.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/failure_history.tsx deleted file mode 100644 index 05665d7c6b3c2e..00000000000000 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/failure_history.tsx +++ /dev/null @@ -1,80 +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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React from 'react'; -import { - EuiBasicTable, - EuiPanel, - EuiLoadingContent, - EuiHealth, - EuiBasicTableColumn, -} from '@elastic/eui'; - -import { RuleExecutionEvent } from '../../../../../../common/detection_engine/schemas/common'; -import { useRuleExecutionEvents } from '../../../../containers/detection_engine/rules'; -import { HeaderSection } from '../../../../../common/components/header_section'; -import * as i18n from './translations'; -import { FormattedDate } from '../../../../../common/components/formatted_date'; - -const columns: Array> = [ - { - name: i18n.COLUMN_STATUS_TYPE, - render: () => {i18n.TYPE_FAILED}, - truncateText: false, - width: '16%', - }, - { - field: 'date', - name: i18n.COLUMN_FAILED_AT, - render: (value: string) => , - sortable: false, - truncateText: false, - width: '24%', - }, - { - field: 'message', - name: i18n.COLUMN_FAILED_MSG, - render: (value: string) => <>{value}, - sortable: false, - truncateText: false, - width: '60%', - }, -]; - -interface FailureHistoryProps { - ruleId: string; -} - -const FailureHistoryComponent: React.FC = ({ ruleId }) => { - const events = useRuleExecutionEvents(ruleId); - const loading = events.isLoading; - const items = events.data ?? []; - - if (loading) { - return ( - - - - - ); - } - - return ( - - - - - ); -}; - -export const FailureHistory = React.memo(FailureHistoryComponent); -FailureHistory.displayName = 'FailureHistory'; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx index 4f91b9208ab6c8..791a3fcd0a5b4a 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/index.tsx @@ -104,10 +104,10 @@ import { RuleStatusFailedCallOut, ruleStatusI18n, } from '../../../../components/rules/rule_execution_status'; -import { FailureHistory } from './failure_history'; import * as detectionI18n from '../../translations'; import * as ruleI18n from '../translations'; +import { ExecutionLogTable } from './execution_log_table/execution_log_table'; import * as i18n from './translations'; import { NeedAdminForUpdateRulesCallOut } from '../../../../components/callouts/need_admin_for_update_callout'; import { MissingPrivilegesCallOut } from '../../../../components/callouts/missing_privileges_callout'; @@ -133,7 +133,7 @@ const StyledFullHeightContainer = styled.div` enum RuleDetailTabs { alerts = 'alerts', - failures = 'failures', + executionLogs = 'executionLogs', exceptions = 'exceptions', } @@ -151,10 +151,10 @@ const ruleDetailTabs = [ dataTestSubj: 'exceptionsTab', }, { - id: RuleDetailTabs.failures, - name: i18n.FAILURE_HISTORY_TAB, + id: RuleDetailTabs.executionLogs, + name: i18n.RULE_EXECUTION_LOGS, disabled: false, - dataTestSubj: 'failureHistoryTab', + dataTestSubj: 'executionLogsTab', }, ]; @@ -431,7 +431,7 @@ const RuleDetailsPageComponent: React.FC = ({ setRuleDetailTab(tab.id)} isSelected={tab.id === ruleDetailTab} - disabled={tab.disabled} + disabled={tab.disabled || (tab.id === RuleDetailTabs.executionLogs && !isExistingRule)} key={tab.id} data-test-subj={tab.dataTestSubj} > @@ -440,7 +440,7 @@ const RuleDetailsPageComponent: React.FC = ({ ))} ), - [ruleDetailTab, setRuleDetailTab, pageTabs] + [isExistingRule, ruleDetailTab, setRuleDetailTab, pageTabs] ); const ruleIndices = useMemo(() => rule?.index ?? DEFAULT_INDEX_PATTERN, [rule?.index]); @@ -605,6 +605,10 @@ const RuleDetailsPageComponent: React.FC = ({ [containerElement, onSkipFocusBeforeEventsTable, onSkipFocusAfterEventsTable] ); + const selectAlertsTabCallback = useCallback(() => { + setRuleDetailTab(RuleDetailTabs.alerts); + }, []); + if ( redirectToDetections( isSignalIndexExists, @@ -806,7 +810,9 @@ const RuleDetailsPageComponent: React.FC = ({ onRuleChange={refreshRule} /> )} - {ruleDetailTab === RuleDetailTabs.failures && } + {ruleDetailTab === RuleDetailTabs.executionLogs && ( + + )} diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/translations.ts b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/translations.ts index 9a51952d17a916..595396e0fd28a1 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/translations.ts +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/details/translations.ts @@ -42,38 +42,10 @@ export const UNKNOWN = i18n.translate( } ); -export const FAILURE_HISTORY_TAB = i18n.translate( - 'xpack.securitySolution.detectionEngine.ruleDetails.failureHistoryTab', +export const RULE_EXECUTION_LOGS = i18n.translate( + 'xpack.securitySolution.detectionEngine.ruleDetails.ruleExecutionLogsTab', { - defaultMessage: 'Failure History', - } -); - -export const LAST_FIVE_ERRORS = i18n.translate( - 'xpack.securitySolution.detectionEngine.ruleDetails.lastFiveErrorsTitle', - { - defaultMessage: 'Last five errors', - } -); - -export const COLUMN_STATUS_TYPE = i18n.translate( - 'xpack.securitySolution.detectionEngine.ruleDetails.statusTypeColumn', - { - defaultMessage: 'Type', - } -); - -export const COLUMN_FAILED_AT = i18n.translate( - 'xpack.securitySolution.detectionEngine.ruleDetails.statusFailedAtColumn', - { - defaultMessage: 'Failed at', - } -); - -export const COLUMN_FAILED_MSG = i18n.translate( - 'xpack.securitySolution.detectionEngine.ruleDetails.statusFailedMsgColumn', - { - defaultMessage: 'Failed message', + defaultMessage: 'Rule execution logs ', } ); diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/translations.ts b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/translations.ts index f2f3ef2828e9bc..55a564f472c59a 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/translations.ts +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/translations.ts @@ -584,6 +584,13 @@ export const COLUMN_GAP = i18n.translate( } ); +export const COLUMN_GAP_TOOLTIP_SEE_DOCUMENTATION = i18n.translate( + 'xpack.securitySolution.detectionEngine.rules.allRules.columns.gapTooltipSeeDocsDescription', + { + defaultMessage: 'see documentation', + } +); + export const RULES_TAB = i18n.translate( 'xpack.securitySolution.detectionEngine.rules.allRules.tabs.rules', { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts index 9118df4fc413f6..0c9418657a4eb0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts @@ -25,6 +25,7 @@ import { DETECTION_ENGINE_RULES_BULK_ACTION, DETECTION_ENGINE_RULE_EXECUTION_EVENTS_URL, } from '../../../../../common/constants'; +import { GetAggregateRuleExecutionEventsResponse } from '../../../../../common/detection_engine/schemas/response'; import { RuleAlertType, HapiReadableStream } from '../../rules/types'; import { requestMock } from './request'; import { QuerySignalsSchemaDecoded } from '../../../../../common/detection_engine/schemas/request/query_signals_index_schema'; @@ -242,6 +243,12 @@ export const getRuleExecutionEventsRequest = () => params: { ruleId: '04128c15-0d1b-4716-a4c5-46997ac7f3bd', }, + query: { + start: 'now-30', + end: 'now', + query_text: '', + status_filters: '', + }, }); export const getImportRulesRequest = (hapiStream?: HapiReadableStream) => @@ -552,6 +559,59 @@ export const getLastFailures = (): RuleExecutionEvent[] => [ }, ]; +export const getAggregateExecutionEvents = (): GetAggregateRuleExecutionEventsResponse => ({ + events: [ + { + execution_uuid: '34bab6e0-89b6-4d10-9cbb-cda76d362db6', + timestamp: '2022-03-11T22:04:05.931Z', + duration_ms: 1975, + status: 'success', + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + num_active_alerts: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_triggered_actions: 0, + num_succeeded_actions: 0, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 538, + schedule_delay_ms: 2091, + timed_out: false, + indexing_duration_ms: 7, + search_duration_ms: 551, + gap_duration_ms: 0, + security_status: 'succeeded', + security_message: 'succeeded', + }, + { + execution_uuid: '254d8400-9dc7-43c5-ad4b-227273d1a44b', + timestamp: '2022-03-11T22:02:41.923Z', + duration_ms: 11916, + status: 'success', + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + num_active_alerts: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_triggered_actions: 1, + num_succeeded_actions: 1, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 1406, + schedule_delay_ms: 1583, + timed_out: false, + indexing_duration_ms: 0, + search_duration_ms: 0, + gap_duration_ms: 0, + security_status: 'partial failure', + security_message: + 'Check privileges failed to execute ResponseError: index_not_found_exception: [index_not_found_exception] Reason: no such index [broken-index] name: "This Rule Makes Alerts, Actions, AND Moar!" id: "f78f3550-a186-11ec-89a1-0bce95157aba" rule id: "b64b4540-d035-4826-a1e7-f505bf4b9653" execution id: "254d8400-9dc7-43c5-ad4b-227273d1a44b" space ID: "default"', + }, + ], + total: 2, +}); + export const getBasicEmptySearchResponse = (): estypes.SearchResponse => ({ took: 1, timed_out: false, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_rule_execution_events_route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_rule_execution_events_route.test.ts index 97cba0f3b4f340..b24789d77a9bb9 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_rule_execution_events_route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_rule_execution_events_route.test.ts @@ -6,9 +6,14 @@ */ import { serverMock, requestContextMock } from '../__mocks__'; -import { getRuleExecutionEventsRequest, getLastFailures } from '../__mocks__/request_responses'; +import { + getRuleExecutionEventsRequest, + getAggregateExecutionEvents, +} from '../__mocks__/request_responses'; import { getRuleExecutionEventsRoute } from './get_rule_execution_events_route'; +// TODO: Add additional tests for param validation + describe('getRuleExecutionEventsRoute', () => { let server: ReturnType; let { clients, context } = requestContextMock.createTools(); @@ -22,21 +27,19 @@ describe('getRuleExecutionEventsRoute', () => { describe('when it finds events in rule execution log', () => { it('returns 200 response with the events', async () => { - const lastFailures = getLastFailures(); - clients.ruleExecutionLog.getLastFailures.mockResolvedValue(lastFailures); + const executionEvents = getAggregateExecutionEvents(); + clients.ruleExecutionLog.getAggregateExecutionEvents.mockResolvedValue(executionEvents); const response = await server.inject(getRuleExecutionEventsRequest(), context); expect(response.status).toEqual(200); - expect(response.body).toEqual({ - events: lastFailures, - }); + expect(response.body).toEqual(executionEvents); }); }); describe('when rule execution log client throws an error', () => { it('returns 500 response with it', async () => { - clients.ruleExecutionLog.getLastFailures.mockRejectedValue(new Error('Boom!')); + clients.ruleExecutionLog.getAggregateExecutionEvents.mockRejectedValue(new Error('Boom!')); const response = await server.inject(getRuleExecutionEventsRequest(), context); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_rule_execution_events_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_rule_execution_events_route.ts index 4a3e0aef8b2c7c..d74f1df3297301 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_rule_execution_events_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/get_rule_execution_events_route.ts @@ -6,20 +6,20 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; +import { GetAggregateRuleExecutionEventsResponse } from '../../../../../common/detection_engine/schemas/response'; import { buildRouteValidation } from '../../../../utils/build_validation/route_validation'; import { buildSiemResponse } from '../utils'; import type { SecuritySolutionPluginRouter } from '../../../../types'; import { DETECTION_ENGINE_RULE_EXECUTION_EVENTS_URL } from '../../../../../common/constants'; -import { GetRuleExecutionEventsRequestParams } from '../../../../../common/detection_engine/schemas/request/get_rule_execution_events_request'; -import { GetRuleExecutionEventsResponse } from '../../../../../common/detection_engine/schemas/response/get_rule_execution_events_response'; +import { + GetRuleExecutionEventsQueryParams, + GetRuleExecutionEventsRequestParams, +} from '../../../../../common/detection_engine/schemas/request/get_rule_execution_events_schema'; /** - * Returns execution events of a given rule (e.g. status changes) from Event Log. - * Accepts rule's saved object ID (`rule.id`). - * - * NOTE: This endpoint is under construction. It will be extended and finalized. - * https://github.com/elastic/kibana/issues/119598 + * Returns execution events of a given rule (aggregated by executionId) from Event Log. + * Accepts rule's saved object ID (`rule.id`), `start`, `end` and `filters` query params. */ export const getRuleExecutionEventsRoute = (router: SecuritySolutionPluginRouter) => { router.get( @@ -27,6 +27,7 @@ export const getRuleExecutionEventsRoute = (router: SecuritySolutionPluginRouter path: DETECTION_ENGINE_RULE_EXECUTION_EVENTS_URL, validate: { params: buildRouteValidation(GetRuleExecutionEventsRequestParams), + query: buildRouteValidation(GetRuleExecutionEventsQueryParams), }, options: { tags: ['access:securitySolution'], @@ -34,14 +35,35 @@ export const getRuleExecutionEventsRoute = (router: SecuritySolutionPluginRouter }, async (context, request, response) => { const { ruleId } = request.params; + const { + start, + end, + query_text: queryText = '', + status_filters: statusFilters = '', + page, + per_page: perPage, + sort_field: sortField = 'timestamp', + sort_order: sortOrder = 'desc', + } = request.query; const siemResponse = buildSiemResponse(response); try { const executionLog = context.securitySolution.getRuleExecutionLog(); - const executionEvents = await executionLog.getLastFailures(ruleId); + const { events, total } = await executionLog.getAggregateExecutionEvents({ + ruleId, + start, + end, + queryText, + statusFilters: statusFilters.length ? statusFilters.split(',') : [], + page: page != null ? parseInt(page, 10) : 0, + perPage: perPage != null ? parseInt(perPage, 10) : 10, + sortField, + sortOrder, + }); - const responseBody: GetRuleExecutionEventsResponse = { - events: executionEvents, + const responseBody: GetAggregateRuleExecutionEventsResponse = { + events, + total, }; return response.ok({ body: responseBody }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/__mocks__/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/__mocks__/index.ts index dbad1e95cb7d6d..04516f22734db3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/__mocks__/index.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/__mocks__/index.ts @@ -13,6 +13,7 @@ import { const ruleExecutionLogForRoutesMock = { create: (): jest.Mocked => ({ + getAggregateExecutionEvents: jest.fn(), getExecutionSummariesBulk: jest.fn(), getExecutionSummary: jest.fn(), clearExecutionSummary: jest.fn(), diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/client_for_routes/client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/client_for_routes/client.ts index a4c528d941ba44..1ee23da39fe74c 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/client_for_routes/client.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/client_for_routes/client.ts @@ -7,6 +7,7 @@ import { chunk, mapValues } from 'lodash'; import { Logger } from 'src/core/server'; +import { GetAggregateRuleExecutionEventsResponse } from '../../../../../common/detection_engine/schemas/response'; import { initPromisePool } from '../../../../utils/promise_pool'; import { withSecuritySpan } from '../../../../utils/with_security_span'; @@ -14,7 +15,7 @@ import { RuleExecutionStatus } from '../../../../../common/detection_engine/sche import { IEventLogReader } from '../event_log/event_log_reader'; import { IRuleExecutionSavedObjectsClient } from '../execution_saved_object/saved_objects_client'; -import { IRuleExecutionLogForRoutes } from './client_interface'; +import { GetAggregateExecutionEventsArgs, IRuleExecutionLogForRoutes } from './client_interface'; import { ExtMeta } from '../utils/console_logging'; import { truncateList } from '../utils/normalization'; @@ -28,6 +29,47 @@ export const createClientForRoutes = ( logger: Logger ): IRuleExecutionLogForRoutes => { return { + getAggregateExecutionEvents({ + ruleId, + start, + end, + queryText, + statusFilters, + page, + perPage, + sortField, + sortOrder, + }: GetAggregateExecutionEventsArgs): Promise { + return withSecuritySpan( + 'IRuleExecutionLogForRoutes.getAggregateExecutionEvents', + async () => { + try { + return await eventLog.getAggregateExecutionEvents({ + ruleId, + start, + end, + queryText, + statusFilters, + page, + perPage, + sortField, + sortOrder, + }); + } catch (e) { + const logMessage = + 'Error getting last aggregation of execution failures from event log'; + const logAttributes = `rule id: "${ruleId}"`; + const logReason = e instanceof Error ? e.message : String(e); + const logMeta: ExtMeta = { + rule: { id: ruleId }, + }; + + logger.error(`${logMessage}; ${logAttributes}; ${logReason}`, logMeta); + throw e; + } + } + ); + }, /** * Get the current rule execution summary for each of the given rule IDs. * This method splits work into chunks so not to overwhelm Elasticsearch diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/client_for_routes/client_interface.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/client_for_routes/client_interface.ts index 14f99762ed6ef6..541eaa827097d1 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/client_for_routes/client_interface.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/client_for_routes/client_interface.ts @@ -9,6 +9,19 @@ import { RuleExecutionEvent, RuleExecutionSummary, } from '../../../../../common/detection_engine/schemas/common'; +import { GetAggregateRuleExecutionEventsResponse } from '../../../../../common/detection_engine/schemas/response'; + +export interface GetAggregateExecutionEventsArgs { + ruleId: string; + start: string; + end: string; + queryText: string; + statusFilters: string[]; + page: number; + perPage: number; + sortField: string; + sortOrder: string; +} /** * Used from route handlers to fetch and manage various information about the rule execution: @@ -16,6 +29,31 @@ import { * - execution events such as recent failures and status changes */ export interface IRuleExecutionLogForRoutes { + /** + * Fetches list of execution events aggregated by executionId, combining data from both alerting + * and security-solution event-log documents + * @param ruleId Saved object id of the rule (`rule.id`). + * @param start start of daterange to filter to + * @param end end of daterange to filter to + * @param queryText string of field-based filters, e.g. kibana.alert.rule.execution.status:* + * @param statusFilters array of status filters, e.g. ['succeeded', 'going to run'] + * @param page current page to fetch + * @param perPage number of results to fetch per page + * @param sortField field to sort by + * @param sortOrder what order to sort by (e.g. `asc` or `desc`) + */ + getAggregateExecutionEvents({ + ruleId, + start, + end, + queryText, + statusFilters, + page, + perPage, + sortField, + sortOrder, + }: GetAggregateExecutionEventsArgs): Promise; + /** * Fetches a list of current execution summaries of multiple rules. * @param ruleIds A list of saved object ids of multiple rules (`rule.id`). diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/event_log_reader.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/event_log_reader.ts index 3a59c26c769eea..765defb8037569 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/event_log_reader.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/event_log_reader.ts @@ -5,12 +5,15 @@ * 2.0. */ +import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { MAX_EXECUTION_EVENTS_DISPLAYED } from '@kbn/securitysolution-rules'; import { IEventLogClient } from '../../../../../../event_log/server'; import { RuleExecutionEvent, RuleExecutionStatus, } from '../../../../../common/detection_engine/schemas/common'; +import { GetAggregateRuleExecutionEventsResponse } from '../../../../../common/detection_engine/schemas/response'; import { invariant } from '../../../../../common/utils/invariant'; import { withSecuritySpan } from '../../../../utils/with_security_span'; import { @@ -18,11 +21,32 @@ import { RULE_EXECUTION_LOG_PROVIDER, RuleExecutionLogAction, } from './constants'; +import { + formatExecutionEventResponse, + getExecutionEventAggregation, +} from './get_execution_event_aggregation'; +import { ExecutionUuidAggResult } from './get_execution_event_aggregation/types'; export interface IEventLogReader { + getAggregateExecutionEvents( + args: GetAggregateExecutionEventsArgs + ): Promise; + getLastStatusChanges(args: GetLastStatusChangesArgs): Promise; } +export interface GetAggregateExecutionEventsArgs { + ruleId: string; + start: string; + end: string; + queryText: string; + statusFilters: string[]; + page: number; + perPage: number; + sortField: string; + sortOrder: string; +} + export interface GetLastStatusChangesArgs { ruleId: string; count: number; @@ -31,6 +55,64 @@ export interface GetLastStatusChangesArgs { export const createEventLogReader = (eventLog: IEventLogClient): IEventLogReader => { return { + async getAggregateExecutionEvents( + args: GetAggregateExecutionEventsArgs + ): Promise { + const { ruleId, start, end, statusFilters, page, perPage, sortField, sortOrder } = args; + const soType = RULE_SAVED_OBJECT_TYPE; + const soIds = [ruleId]; + + // Current workaround to support root level filters without missing fields in the aggregate event + // or including events from statuses that aren't selected + // TODO: See: https://github.com/elastic/kibana/pull/127339/files#r825240516 + // First fetch execution uuid's by status filter if provided + let statusIds: string[] = []; + // If 0 or 3 statuses are selected we can search for all statuses and don't need this pre-filter by ID + if (statusFilters.length > 0 && statusFilters.length < 3) { + // TODO: Add cardinality agg and pass as maxEvents in response + const statusResults = await eventLog.aggregateEventsBySavedObjectIds(soType, soIds, { + start, + end, + filter: `kibana.alert.rule.execution.status:(${statusFilters.join(' OR ')})`, + aggs: { + filteredExecutionUUIDs: { + terms: { + field: 'kibana.alert.rule.execution.uuid', + size: MAX_EXECUTION_EVENTS_DISPLAYED, + }, + }, + }, + }); + const filteredExecutionUUIDs = statusResults.aggregations + ?.filteredExecutionUUIDs as ExecutionUuidAggResult; + statusIds = filteredExecutionUUIDs?.buckets?.map((b) => b.key) ?? []; + // Early return if no results based on status filter + if (statusIds.length === 0) { + return { + total: 0, + events: [], + }; + } + } + + // Now query for aggregate events, and pass any ID's as filters as determined from the above status/queryText results + const idsFilter = statusIds.length + ? `kibana.alert.rule.execution.uuid:(${statusIds.join(' OR ')})` + : ''; + const results = await eventLog.aggregateEventsBySavedObjectIds(soType, soIds, { + start, + end, + filter: idsFilter, + aggs: getExecutionEventAggregation({ + maxExecutions: MAX_EXECUTION_EVENTS_DISPLAYED, + page, + perPage, + sort: [{ [sortField]: { order: sortOrder } }] as estypes.Sort, + }), + }); + + return formatExecutionEventResponse(results); + }, async getLastStatusChanges(args) { const soType = RULE_SAVED_OBJECT_TYPE; const soIds = [args.ruleId]; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/index.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/index.test.ts new file mode 100644 index 00000000000000..d90d262688e86e --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/index.test.ts @@ -0,0 +1,1321 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { MAX_EXECUTION_EVENTS_DISPLAYED } from '@kbn/securitysolution-rules'; + +import { + formatExecutionEventResponse, + formatSortForBucketSort, + formatSortForTermsSort, + getExecutionEventAggregation, + getProviderAndActionFilter, +} from './index'; + +describe('getExecutionEventAggregation', () => { + test('should throw error when given bad maxExecutions field', () => { + expect(() => { + getExecutionEventAggregation({ + maxExecutions: 1001, + page: 1, + perPage: 10, + sort: [{ timestamp: { order: 'asc' } }], + }); + }).toThrowErrorMatchingInlineSnapshot( + `"Invalid maxExecutions requested \\"1001\\" - must be less than ${MAX_EXECUTION_EVENTS_DISPLAYED}"` + ); + }); + + test('should throw error when given bad page field', () => { + expect(() => { + getExecutionEventAggregation({ + maxExecutions: 5, + page: -1, + perPage: 10, + sort: [{ timestamp: { order: 'asc' } }], + }); + }).toThrowErrorMatchingInlineSnapshot(`"Invalid page field \\"-1\\" - must be greater than 0"`); + }); + + test('should throw error when given bad perPage field', () => { + expect(() => { + getExecutionEventAggregation({ + maxExecutions: 5, + page: 1, + perPage: 0, + sort: [{ timestamp: { order: 'asc' } }], + }); + }).toThrowErrorMatchingInlineSnapshot( + `"Invalid perPage field \\"0\\" - must be greater than 0"` + ); + }); + + test('should throw error when given bad sort field', () => { + expect(() => { + getExecutionEventAggregation({ + maxExecutions: 5, + page: 1, + perPage: 10, + sort: [{ notsortable: { order: 'asc' } }], + }); + }).toThrowErrorMatchingInlineSnapshot( + `"Invalid sort field \\"notsortable\\" - must be one of [timestamp,duration_ms,indexing_duration_ms,search_duration_ms,gap_duration_ms,schedule_delay_ms,num_triggered_actions]"` + ); + }); + + test('should throw error when given one bad sort field', () => { + expect(() => { + getExecutionEventAggregation({ + maxExecutions: 5, + page: 1, + perPage: 10, + sort: [{ notsortable: { order: 'asc' } }, { timestamp: { order: 'asc' } }], + }); + }).toThrowErrorMatchingInlineSnapshot( + `"Invalid sort field \\"notsortable\\" - must be one of [timestamp,duration_ms,indexing_duration_ms,search_duration_ms,gap_duration_ms,schedule_delay_ms,num_triggered_actions]"` + ); + }); + + test('should correctly generate aggregation', () => { + expect( + getExecutionEventAggregation({ + maxExecutions: 5, + page: 2, + perPage: 10, + sort: [{ timestamp: { order: 'asc' } }, { duration_ms: { order: 'desc' } }], + }) + ).toEqual({ + totalExecutions: { + cardinality: { + field: 'kibana.alert.rule.execution.uuid', + }, + }, + executionUuid: { + terms: { + field: 'kibana.alert.rule.execution.uuid', + size: 5, + order: [ + { + 'ruleExecution>executeStartTime': 'asc', + }, + { + 'ruleExecution>executionDuration': 'desc', + }, + ], + }, + aggs: { + executionUuidSorted: { + bucket_sort: { + sort: [ + { + 'ruleExecution>executeStartTime': { + order: 'asc', + }, + }, + { + 'ruleExecution>executionDuration': { + order: 'desc', + }, + }, + ], + from: 20, + size: 10, + gap_policy: 'insert_zeros', + }, + }, + actionExecution: { + filter: { + bool: { + must: [ + { + match: { + 'event.action': 'execute', + }, + }, + { + match: { + 'event.provider': 'actions', + }, + }, + ], + }, + }, + aggs: { + actionOutcomes: { + terms: { + field: 'event.outcome', + size: 2, + }, + }, + }, + }, + ruleExecution: { + filter: { + bool: { + must: [ + { + match: { + 'event.action': 'execute', + }, + }, + { + match: { + 'event.provider': 'alerting', + }, + }, + ], + }, + }, + aggs: { + executeStartTime: { + min: { + field: 'event.start', + }, + }, + scheduleDelay: { + max: { + field: 'kibana.task.schedule_delay', + }, + }, + esSearchDuration: { + max: { + field: 'kibana.alert.rule.execution.metrics.es_search_duration_ms', + }, + }, + numTriggeredActions: { + max: { + field: 'kibana.alert.rule.execution.metrics.number_of_triggered_actions', + }, + }, + executionDuration: { + max: { + field: 'event.duration', + }, + }, + outcomeAndMessage: { + top_hits: { + size: 1, + _source: { + includes: ['event.outcome', 'message'], + }, + }, + }, + }, + }, + securityMetrics: { + filter: { + bool: { + must: [ + { + match: { + 'event.action': 'execution-metrics', + }, + }, + { + match: { + 'event.provider': 'securitySolution.ruleExecution', + }, + }, + ], + }, + }, + aggs: { + gapDuration: { + min: { + field: 'kibana.alert.rule.execution.metrics.execution_gap_duration_s', + missing: 0, + }, + }, + indexDuration: { + min: { + field: 'kibana.alert.rule.execution.metrics.total_indexing_duration_ms', + }, + }, + searchDuration: { + min: { + field: 'kibana.alert.rule.execution.metrics.total_search_duration_ms', + }, + }, + }, + }, + securityStatus: { + filter: { + bool: { + must: [ + { + match: { + 'event.action': 'status-change', + }, + }, + { + match: { + 'event.provider': 'securitySolution.ruleExecution', + }, + }, + ], + }, + }, + aggs: { + status: { + top_hits: { + sort: { + '@timestamp': { + order: 'desc', + }, + }, + size: 1, + _source: { + includes: 'kibana.alert.rule.execution.status', + }, + }, + }, + message: { + top_hits: { + size: 1, + sort: { + '@timestamp': { + order: 'desc', + }, + }, + _source: { + includes: 'message', + }, + }, + }, + }, + }, + timeoutMessage: { + filter: { + bool: { + must: [ + { + match: { + 'event.action': 'execute-timeout', + }, + }, + { + match: { + 'event.provider': 'alerting', + }, + }, + ], + }, + }, + }, + }, + }, + }); + }); +}); + +describe('getProviderAndActionFilter', () => { + test('should correctly format array of sort combinations for bucket sorting', () => { + expect(getProviderAndActionFilter('securitySolution.ruleExecution', 'status-change')).toEqual({ + bool: { + must: [ + { match: { 'event.action': 'status-change' } }, + { match: { 'event.provider': 'securitySolution.ruleExecution' } }, + ], + }, + }); + }); +}); + +describe('formatSortForBucketSort', () => { + test('should correctly format array of sort combinations for bucket sorting', () => { + expect( + formatSortForBucketSort([{ timestamp: { order: 'desc' } }, { duration_ms: { order: 'asc' } }]) + ).toEqual([ + { 'ruleExecution>executeStartTime': { order: 'desc' } }, + { 'ruleExecution>executionDuration': { order: 'asc' } }, + ]); + }); +}); + +describe('formatSortForTermsSort', () => { + test('should correctly format array of sort combinations for bucket sorting', () => { + expect( + formatSortForTermsSort([{ timestamp: { order: 'desc' } }, { duration_ms: { order: 'asc' } }]) + ).toEqual([ + { 'ruleExecution>executeStartTime': 'desc' }, + { 'ruleExecution>executionDuration': 'asc' }, + ]); + }); +}); + +describe('formatExecutionEventResponse', () => { + test('should return empty results if aggregations are undefined', () => { + expect(formatExecutionEventResponse({ aggregations: undefined })).toEqual({ + total: 0, + events: [], + }); + }); + test('should format results correctly', () => { + const results = { + aggregations: { + executionUuid: { + meta: {}, + doc_count_error_upper_bound: -1, + sum_other_doc_count: 1184, + buckets: [ + { + key: '01e458c9-d01a-4359-94f9-1ed256c6488e', + doc_count: 6, + timeoutMessage: { + meta: {}, + doc_count: 0, + }, + securityMetrics: { + meta: {}, + doc_count: 1, + searchDuration: { + value: 480.0, + }, + indexDuration: { + value: 7.0, + }, + gapDuration: { + value: 0.0, + }, + }, + ruleExecution: { + meta: {}, + doc_count: 1, + numTriggeredActions: { + value: 0.0, + }, + scheduleDelay: { + value: 3.147e9, + }, + outcomeAndMessage: { + hits: { + total: { + value: 1, + relation: 'eq', + }, + max_score: 1.0, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'Ca-qiX8Brb7RSEAgSLXB', + _score: 1.0, + _source: { + event: { + outcome: 'success', + }, + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + }, + }, + ], + }, + }, + esSearchDuration: { + value: 464.0, + }, + executionDuration: { + value: 1.775e9, + }, + executeStartTime: { + value: 1.647282110867e12, + value_as_string: '2022-03-14T18:21:50.867Z', + }, + }, + actionExecution: { + meta: {}, + doc_count: 0, + actionOutcomes: { + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [], + }, + }, + securityStatus: { + meta: {}, + doc_count: 2, + message: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'B6-qiX8Brb7RSEAgSLXB', + _score: null, + _source: { + message: 'succeeded', + }, + sort: [1647282112198], + }, + ], + }, + }, + status: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'B6-qiX8Brb7RSEAgSLXB', + _score: null, + _source: { + kibana: { + alert: { + rule: { + execution: { + status: 'succeeded', + }, + }, + }, + }, + }, + sort: [1647282112198], + }, + ], + }, + }, + }, + }, + { + key: '02b7c7a4-ae1a-4da5-b134-c2fb96eb0e04', + doc_count: 5, + timeoutMessage: { + meta: {}, + doc_count: 0, + }, + securityMetrics: { + meta: {}, + doc_count: 1, + searchDuration: { + value: 9.0, + }, + indexDuration: { + value: 0.0, + }, + gapDuration: { + value: 0.0, + }, + }, + ruleExecution: { + meta: {}, + doc_count: 1, + numTriggeredActions: { + value: 0.0, + }, + scheduleDelay: { + value: 9.96e8, + }, + outcomeAndMessage: { + hits: { + total: { + value: 1, + relation: 'eq', + }, + max_score: 1.0, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'pK84iX8Brb7RSEAg3a-L', + _score: 1.0, + _source: { + event: { + outcome: 'success', + }, + message: + "rule executed: siem.queryRule:7457b121-a3a8-11ec-a0f0-cbd1c2ae6ee8: 'Endpoint Security'", + }, + }, + ], + }, + }, + esSearchDuration: { + value: 5.0, + }, + executionDuration: { + value: 1.922e9, + }, + executeStartTime: { + value: 1.647274677664e12, + value_as_string: '2022-03-14T16:17:57.664Z', + }, + }, + actionExecution: { + meta: {}, + doc_count: 0, + actionOutcomes: { + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [], + }, + }, + securityStatus: { + meta: {}, + doc_count: 2, + message: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'o684iX8Brb7RSEAg2a-j', + _score: null, + _source: { + message: 'succeeded', + }, + sort: [1647274678629], + }, + ], + }, + }, + status: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'o684iX8Brb7RSEAg2a-j', + _score: null, + _source: { + kibana: { + alert: { + rule: { + execution: { + status: 'succeeded', + }, + }, + }, + }, + }, + sort: [1647274678629], + }, + ], + }, + }, + }, + }, + ], + }, + totalExecutions: { + value: 768, + }, + }, + }; + expect(formatExecutionEventResponse(results)).toEqual({ + total: 768, + events: [ + { + execution_uuid: '01e458c9-d01a-4359-94f9-1ed256c6488e', + timestamp: '2022-03-14T18:21:50.867Z', + duration_ms: 1775, + status: 'success', + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + num_active_alerts: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_triggered_actions: 0, + num_succeeded_actions: 0, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 464, + schedule_delay_ms: 3147, + timed_out: false, + indexing_duration_ms: 7, + search_duration_ms: 480, + gap_duration_ms: 0, + security_status: 'succeeded', + security_message: 'succeeded', + }, + { + execution_uuid: '02b7c7a4-ae1a-4da5-b134-c2fb96eb0e04', + timestamp: '2022-03-14T16:17:57.664Z', + duration_ms: 1922, + status: 'success', + message: + "rule executed: siem.queryRule:7457b121-a3a8-11ec-a0f0-cbd1c2ae6ee8: 'Endpoint Security'", + num_active_alerts: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_triggered_actions: 0, + num_succeeded_actions: 0, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 5, + schedule_delay_ms: 996, + timed_out: false, + indexing_duration_ms: 0, + search_duration_ms: 9, + gap_duration_ms: 0, + security_status: 'succeeded', + security_message: 'succeeded', + }, + ], + }); + }); + + test('should format results correctly when execution timeouts occur', () => { + const results = { + aggregations: { + executionUuid: { + meta: {}, + doc_count_error_upper_bound: -1, + sum_other_doc_count: 1184, + buckets: [ + { + key: '01e458c9-d01a-4359-94f9-1ed256c6488e', + doc_count: 6, + timeoutMessage: { + meta: {}, + doc_count: 1, + }, + securityMetrics: { + meta: {}, + doc_count: 1, + searchDuration: { + value: 480.0, + }, + indexDuration: { + value: 7.0, + }, + gapDuration: { + value: 0.0, + }, + }, + ruleExecution: { + meta: {}, + doc_count: 1, + numTriggeredActions: { + value: 0.0, + }, + scheduleDelay: { + value: 3.147e9, + }, + outcomeAndMessage: { + hits: { + total: { + value: 1, + relation: 'eq', + }, + max_score: 1.0, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'Ca-qiX8Brb7RSEAgSLXB', + _score: 1.0, + _source: { + event: { + outcome: 'success', + }, + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + }, + }, + ], + }, + }, + esSearchDuration: { + value: 464.0, + }, + executionDuration: { + value: 1.775e9, + }, + executeStartTime: { + value: 1.647282110867e12, + value_as_string: '2022-03-14T18:21:50.867Z', + }, + }, + actionExecution: { + meta: {}, + doc_count: 0, + actionOutcomes: { + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [], + }, + }, + securityStatus: { + meta: {}, + doc_count: 2, + message: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'B6-qiX8Brb7RSEAgSLXB', + _score: null, + _source: { + message: 'succeeded', + }, + sort: [1647282112198], + }, + ], + }, + }, + status: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'B6-qiX8Brb7RSEAgSLXB', + _score: null, + _source: { + kibana: { + alert: { + rule: { + execution: { + status: 'succeeded', + }, + }, + }, + }, + }, + sort: [1647282112198], + }, + ], + }, + }, + }, + }, + { + key: '02b7c7a4-ae1a-4da5-b134-c2fb96eb0e04', + doc_count: 5, + timeoutMessage: { + meta: {}, + doc_count: 0, + }, + securityMetrics: { + meta: {}, + doc_count: 1, + searchDuration: { + value: 9.0, + }, + indexDuration: { + value: 0.0, + }, + gapDuration: { + value: 0.0, + }, + }, + ruleExecution: { + meta: {}, + doc_count: 1, + numTriggeredActions: { + value: 0.0, + }, + scheduleDelay: { + value: 9.96e8, + }, + outcomeAndMessage: { + hits: { + total: { + value: 1, + relation: 'eq', + }, + max_score: 1.0, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'pK84iX8Brb7RSEAg3a-L', + _score: 1.0, + _source: { + event: { + outcome: 'success', + }, + message: + "rule executed: siem.queryRule:7457b121-a3a8-11ec-a0f0-cbd1c2ae6ee8: 'Endpoint Security'", + }, + }, + ], + }, + }, + esSearchDuration: { + value: 5.0, + }, + executionDuration: { + value: 1.922e9, + }, + executeStartTime: { + value: 1.647274677664e12, + value_as_string: '2022-03-14T16:17:57.664Z', + }, + }, + actionExecution: { + meta: {}, + doc_count: 0, + actionOutcomes: { + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [], + }, + }, + securityStatus: { + meta: {}, + doc_count: 2, + message: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'o684iX8Brb7RSEAg2a-j', + _score: null, + _source: { + message: 'succeeded', + }, + sort: [1647274678629], + }, + ], + }, + }, + status: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'o684iX8Brb7RSEAg2a-j', + _score: null, + _source: { + kibana: { + alert: { + rule: { + execution: { + status: 'succeeded', + }, + }, + }, + }, + }, + sort: [1647274678629], + }, + ], + }, + }, + }, + }, + ], + }, + totalExecutions: { + value: 768, + }, + }, + }; + expect(formatExecutionEventResponse(results)).toEqual({ + total: 768, + events: [ + { + execution_uuid: '01e458c9-d01a-4359-94f9-1ed256c6488e', + timestamp: '2022-03-14T18:21:50.867Z', + duration_ms: 1775, + status: 'success', + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + num_active_alerts: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_triggered_actions: 0, + num_succeeded_actions: 0, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 464, + schedule_delay_ms: 3147, + timed_out: true, + indexing_duration_ms: 7, + search_duration_ms: 480, + gap_duration_ms: 0, + security_status: 'succeeded', + security_message: 'succeeded', + }, + { + execution_uuid: '02b7c7a4-ae1a-4da5-b134-c2fb96eb0e04', + timestamp: '2022-03-14T16:17:57.664Z', + duration_ms: 1922, + status: 'success', + message: + "rule executed: siem.queryRule:7457b121-a3a8-11ec-a0f0-cbd1c2ae6ee8: 'Endpoint Security'", + num_active_alerts: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_triggered_actions: 0, + num_succeeded_actions: 0, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 5, + schedule_delay_ms: 996, + timed_out: false, + indexing_duration_ms: 0, + search_duration_ms: 9, + gap_duration_ms: 0, + security_status: 'succeeded', + security_message: 'succeeded', + }, + ], + }); + }); + + test('should format results correctly when action errors occur', () => { + const results = { + aggregations: { + executionUuid: { + meta: {}, + doc_count_error_upper_bound: -1, + sum_other_doc_count: 1184, + buckets: [ + { + key: '01e458c9-d01a-4359-94f9-1ed256c6488e', + doc_count: 6, + timeoutMessage: { + meta: {}, + doc_count: 1, + }, + securityMetrics: { + meta: {}, + doc_count: 1, + searchDuration: { + value: 480.0, + }, + indexDuration: { + value: 7.0, + }, + gapDuration: { + value: 0.0, + }, + }, + ruleExecution: { + meta: {}, + doc_count: 1, + numTriggeredActions: { + value: 0.0, + }, + scheduleDelay: { + value: 3.147e9, + }, + outcomeAndMessage: { + hits: { + total: { + value: 1, + relation: 'eq', + }, + max_score: 1.0, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'Ca-qiX8Brb7RSEAgSLXB', + _score: 1.0, + _source: { + event: { + outcome: 'success', + }, + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + }, + }, + ], + }, + }, + esSearchDuration: { + value: 464.0, + }, + executionDuration: { + value: 1.775e9, + }, + executeStartTime: { + value: 1.647282110867e12, + value_as_string: '2022-03-14T18:21:50.867Z', + }, + }, + actionExecution: { + meta: {}, + doc_count: 5, + actionOutcomes: { + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [ + { + key: 'success', + doc_count: 5, + }, + ], + }, + }, + securityStatus: { + meta: {}, + doc_count: 2, + message: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'B6-qiX8Brb7RSEAgSLXB', + _score: null, + _source: { + message: 'succeeded', + }, + sort: [1647282112198], + }, + ], + }, + }, + status: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'B6-qiX8Brb7RSEAgSLXB', + _score: null, + _source: { + kibana: { + alert: { + rule: { + execution: { + status: 'succeeded', + }, + }, + }, + }, + }, + sort: [1647282112198], + }, + ], + }, + }, + }, + }, + { + key: '02b7c7a4-ae1a-4da5-b134-c2fb96eb0e04', + doc_count: 5, + timeoutMessage: { + meta: {}, + doc_count: 0, + }, + securityMetrics: { + meta: {}, + doc_count: 1, + searchDuration: { + value: 9.0, + }, + indexDuration: { + value: 0.0, + }, + gapDuration: { + value: 0.0, + }, + }, + ruleExecution: { + meta: {}, + doc_count: 1, + numTriggeredActions: { + value: 0.0, + }, + scheduleDelay: { + value: 9.96e8, + }, + outcomeAndMessage: { + hits: { + total: { + value: 1, + relation: 'eq', + }, + max_score: 1.0, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'pK84iX8Brb7RSEAg3a-L', + _score: 1.0, + _source: { + event: { + outcome: 'success', + }, + message: + "rule executed: siem.queryRule:7457b121-a3a8-11ec-a0f0-cbd1c2ae6ee8: 'Endpoint Security'", + }, + }, + ], + }, + }, + esSearchDuration: { + value: 5.0, + }, + executionDuration: { + value: 1.922e9, + }, + executeStartTime: { + value: 1.647274677664e12, + value_as_string: '2022-03-14T16:17:57.664Z', + }, + }, + actionExecution: { + meta: {}, + doc_count: 0, + actionOutcomes: { + doc_count_error_upper_bound: 0, + sum_other_doc_count: 0, + buckets: [], + }, + }, + securityStatus: { + meta: {}, + doc_count: 2, + message: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'o684iX8Brb7RSEAg2a-j', + _score: null, + _source: { + message: 'succeeded', + }, + sort: [1647274678629], + }, + ], + }, + }, + status: { + hits: { + total: { + value: 2, + relation: 'eq', + }, + max_score: null, + hits: [ + { + _index: '.kibana-event-log-8.2.0-000001', + _id: 'o684iX8Brb7RSEAg2a-j', + _score: null, + _source: { + kibana: { + alert: { + rule: { + execution: { + status: 'succeeded', + }, + }, + }, + }, + }, + sort: [1647274678629], + }, + ], + }, + }, + }, + }, + ], + }, + totalExecutions: { + value: 768, + }, + }, + }; + expect(formatExecutionEventResponse(results)).toEqual({ + total: 768, + events: [ + { + execution_uuid: '01e458c9-d01a-4359-94f9-1ed256c6488e', + timestamp: '2022-03-14T18:21:50.867Z', + duration_ms: 1775, + status: 'success', + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + num_active_alerts: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_triggered_actions: 0, + num_succeeded_actions: 5, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 464, + schedule_delay_ms: 3147, + timed_out: true, + indexing_duration_ms: 7, + search_duration_ms: 480, + gap_duration_ms: 0, + security_status: 'succeeded', + security_message: 'succeeded', + }, + { + execution_uuid: '02b7c7a4-ae1a-4da5-b134-c2fb96eb0e04', + timestamp: '2022-03-14T16:17:57.664Z', + duration_ms: 1922, + status: 'success', + message: + "rule executed: siem.queryRule:7457b121-a3a8-11ec-a0f0-cbd1c2ae6ee8: 'Endpoint Security'", + num_active_alerts: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_triggered_actions: 0, + num_succeeded_actions: 0, + num_errored_actions: 0, + total_search_duration_ms: 0, + es_search_duration_ms: 5, + schedule_delay_ms: 996, + timed_out: false, + indexing_duration_ms: 0, + search_duration_ms: 9, + gap_duration_ms: 0, + security_status: 'succeeded', + security_message: 'succeeded', + }, + ], + }); + }); +}); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/index.ts new file mode 100644 index 00000000000000..a66a2cccd538a3 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/index.ts @@ -0,0 +1,351 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { BadRequestError } from '@kbn/securitysolution-es-utils'; +import { flatMap, get } from 'lodash'; +import { MAX_EXECUTION_EVENTS_DISPLAYED } from '@kbn/securitysolution-rules'; +import { AggregateEventsBySavedObjectResult } from '../../../../../../../event_log/server'; +import { AggregateRuleExecutionEvent } from '../../../../../../common/detection_engine/schemas/common'; +import { GetAggregateRuleExecutionEventsResponse } from '../../../../../../common/detection_engine/schemas/response'; +import { + ExecutionEventAggregationOptions, + ExecutionUuidAggResult, + ExecutionUuidAggBucket, +} from './types'; + +// Base ECS fields +const ACTION_FIELD = 'event.action'; +const DURATION_FIELD = 'event.duration'; +const MESSAGE_FIELD = 'message'; +const PROVIDER_FIELD = 'event.provider'; +const OUTCOME_FIELD = 'event.outcome'; +const START_FIELD = 'event.start'; +const TIMESTAMP_FIELD = '@timestamp'; +// Platform fields +const SCHEDULE_DELAY_FIELD = 'kibana.task.schedule_delay'; +const ES_SEARCH_DURATION_FIELD = 'kibana.alert.rule.execution.metrics.es_search_duration_ms'; +const TOTAL_ACTIONS_TRIGGERED_FIELD = + 'kibana.alert.rule.execution.metrics.number_of_triggered_actions'; +const EXECUTION_UUID_FIELD = 'kibana.alert.rule.execution.uuid'; +// TODO: To be added in https://github.com/elastic/kibana/pull/126210 +// const TOTAL_ALERTS_CREATED: 'kibana.alert.rule.execution.metrics.total_alerts_created', +// const TOTAL_ALERTS_DETECTED: 'kibana.alert.rule.execution.metrics.total_alerts_detected', +// Security fields +const GAP_DURATION_FIELD = 'kibana.alert.rule.execution.metrics.execution_gap_duration_s'; +const INDEXING_DURATION_FIELD = 'kibana.alert.rule.execution.metrics.total_indexing_duration_ms'; +const SEARCH_DURATION_FIELD = 'kibana.alert.rule.execution.metrics.total_search_duration_ms'; +const STATUS_FIELD = 'kibana.alert.rule.execution.status'; + +const ONE_MILLISECOND_AS_NANOSECONDS = 1_000_000; + +const SORT_FIELD_TO_AGG_MAPPING: Record = { + timestamp: 'ruleExecution>executeStartTime', + duration_ms: 'ruleExecution>executionDuration', + indexing_duration_ms: 'securityMetrics>indexDuration', + search_duration_ms: 'securityMetrics>searchDuration', + gap_duration_ms: 'securityMetrics>gapDuration', + schedule_delay_ms: 'ruleExecution>scheduleDelay', + num_triggered_actions: 'ruleExecution>numTriggeredActions', + // TODO: To be added in https://github.com/elastic/kibana/pull/126210 + // total_alerts_created: 'securityMetrics>totalAlertsDetected', + // total_alerts_detected: 'securityMetrics>totalAlertsCreated', +}; + +/** + * Returns `aggs` to be supplied to aggregateEventsBySavedObjectIds + * @param maxExecutions upper bounds of execution events to return (to narrow below max terms agg limit) + * @param page current page to retrieve, starting at 0 + * @param perPage number of execution events to display per page + * @param sort field to sort on + */ +export const getExecutionEventAggregation = ({ + maxExecutions, + page, + perPage, + sort, +}: ExecutionEventAggregationOptions): Record => { + // Last stop validation for any other consumers so there's a friendly message instead of failed ES Query + if (maxExecutions > MAX_EXECUTION_EVENTS_DISPLAYED) { + throw new BadRequestError( + `Invalid maxExecutions requested "${maxExecutions}" - must be less than ${MAX_EXECUTION_EVENTS_DISPLAYED}` + ); + } + + if (page < 0) { + throw new BadRequestError(`Invalid page field "${page}" - must be greater than 0`); + } + + if (perPage <= 0) { + throw new BadRequestError(`Invalid perPage field "${perPage}" - must be greater than 0`); + } + + const sortFields = flatMap(sort as estypes.SortCombinations[], (s) => Object.keys(s)); + for (const field of sortFields) { + if (!Object.keys(SORT_FIELD_TO_AGG_MAPPING).includes(field)) { + throw new BadRequestError( + `Invalid sort field "${field}" - must be one of [${Object.keys( + SORT_FIELD_TO_AGG_MAPPING + ).join(',')}]` + ); + } + } + + return { + // Total unique executions for given root filters + totalExecutions: { + cardinality: { + field: EXECUTION_UUID_FIELD, + }, + }, + executionUuid: { + // Bucket by execution UUID + terms: { + field: EXECUTION_UUID_FIELD, + size: maxExecutions, + order: formatSortForTermsSort(sort), + }, + aggs: { + // Bucket sort for paging + executionUuidSorted: { + bucket_sort: { + sort: formatSortForBucketSort(sort), + from: page * perPage, + size: perPage, + gap_policy: 'insert_zeros', + }, + }, + // Filter by action execute doc to retrieve action outcomes (successful/failed) + actionExecution: { + filter: getProviderAndActionFilter('actions', 'execute'), + aggs: { + actionOutcomes: { + terms: { + field: OUTCOME_FIELD, + size: 2, + }, + }, + }, + }, + // Filter by alerting execute doc to retrieve platform metrics + ruleExecution: { + filter: getProviderAndActionFilter('alerting', 'execute'), + aggs: { + executeStartTime: { + min: { + field: START_FIELD, + }, + }, + scheduleDelay: { + max: { + field: SCHEDULE_DELAY_FIELD, + }, + }, + esSearchDuration: { + max: { + field: ES_SEARCH_DURATION_FIELD, + }, + }, + numTriggeredActions: { + max: { + field: TOTAL_ACTIONS_TRIGGERED_FIELD, + }, + }, + executionDuration: { + max: { + field: DURATION_FIELD, + }, + }, + outcomeAndMessage: { + top_hits: { + size: 1, + _source: { + includes: [OUTCOME_FIELD, MESSAGE_FIELD], + }, + }, + }, + }, + }, + // Filter by securitySolution status-change doc to retrieve security metrics + securityMetrics: { + filter: getProviderAndActionFilter('securitySolution.ruleExecution', 'execution-metrics'), + aggs: { + gapDuration: { + min: { + field: GAP_DURATION_FIELD, + missing: 0, // Necessary for sorting since field isn't written if no gap + }, + }, + indexDuration: { + min: { + field: INDEXING_DURATION_FIELD, + }, + }, + searchDuration: { + min: { + field: SEARCH_DURATION_FIELD, + }, + }, + }, + }, + // Filter by securitySolution ruleExecution doc to retrieve status and message + securityStatus: { + filter: getProviderAndActionFilter('securitySolution.ruleExecution', 'status-change'), + aggs: { + status: { + top_hits: { + sort: { + [TIMESTAMP_FIELD]: { + order: 'desc', + }, + }, + size: 1, + _source: { + includes: STATUS_FIELD, + }, + }, + }, + message: { + top_hits: { + size: 1, + sort: { + [TIMESTAMP_FIELD]: { + order: 'desc', + }, + }, + _source: { + includes: MESSAGE_FIELD, + }, + }, + }, + }, + }, + // If there was a timeout, this filter will return non-zero doc count + timeoutMessage: { + filter: getProviderAndActionFilter('alerting', 'execute-timeout'), + }, + }, + }, + }; +}; + +/** + * Returns bool filter for matching a specific provider AND action combination + * @param provider provider to match + * @param action action to match + */ +export const getProviderAndActionFilter = (provider: string, action: string) => { + return { + bool: { + must: [ + { + match: { + [ACTION_FIELD]: action, + }, + }, + { + match: { + [PROVIDER_FIELD]: provider, + }, + }, + ], + }, + }; +}; + +/** + * Formats aggregate execution event from bucket response + * @param bucket + */ +export const formatAggExecutionEventFromBucket = ( + bucket: ExecutionUuidAggBucket +): AggregateRuleExecutionEvent => { + const durationUs = bucket?.ruleExecution?.executionDuration?.value ?? 0; + const scheduleDelayUs = bucket?.ruleExecution?.scheduleDelay?.value ?? 0; + const timedOut = (bucket?.timeoutMessage?.doc_count ?? 0) > 0; + + const actionOutcomes = bucket?.actionExecution?.actionOutcomes?.buckets ?? []; + const actionExecutionSuccess = actionOutcomes.find((b) => b?.key === 'success')?.doc_count ?? 0; + const actionExecutionError = actionOutcomes.find((b) => b?.key === 'failure')?.doc_count ?? 0; + + return { + execution_uuid: bucket?.key ?? '', + timestamp: bucket?.ruleExecution?.executeStartTime.value_as_string ?? '', + duration_ms: durationUs / ONE_MILLISECOND_AS_NANOSECONDS, + status: bucket?.ruleExecution?.outcomeAndMessage?.hits?.hits[0]?._source?.event?.outcome, + message: bucket?.ruleExecution?.outcomeAndMessage?.hits?.hits[0]?._source?.message, + num_active_alerts: bucket?.alertCounts?.buckets?.activeAlerts?.doc_count ?? 0, + num_new_alerts: bucket?.alertCounts?.buckets?.newAlerts?.doc_count ?? 0, + num_recovered_alerts: bucket?.alertCounts?.buckets?.recoveredAlerts?.doc_count ?? 0, + num_triggered_actions: bucket?.ruleExecution?.numTriggeredActions?.value ?? 0, + num_succeeded_actions: actionExecutionSuccess, + num_errored_actions: actionExecutionError, + total_search_duration_ms: bucket?.ruleExecution?.totalSearchDuration?.value ?? 0, + es_search_duration_ms: bucket?.ruleExecution?.esSearchDuration?.value ?? 0, + schedule_delay_ms: scheduleDelayUs / ONE_MILLISECOND_AS_NANOSECONDS, + timed_out: timedOut, + // security fields + indexing_duration_ms: bucket?.securityMetrics?.indexDuration?.value ?? 0, + search_duration_ms: bucket?.securityMetrics?.searchDuration?.value ?? 0, + gap_duration_ms: bucket?.securityMetrics?.gapDuration?.value ?? 0, + security_status: + bucket?.securityStatus?.status?.hits?.hits[0]?._source?.kibana?.alert?.rule?.execution + ?.status, + security_message: bucket?.securityStatus?.message?.hits?.hits[0]?._source?.message, + }; +}; + +/** + * Formats getAggregateExecutionEvents response from Elasticsearch response + * @param results Elasticsearch response + */ +export const formatExecutionEventResponse = ( + results: AggregateEventsBySavedObjectResult +): GetAggregateRuleExecutionEventsResponse => { + const { aggregations } = results; + + if (!aggregations) { + return { + total: 0, + events: [], + }; + } + + const total = (aggregations.totalExecutions as estypes.AggregationsCardinalityAggregate).value; + const buckets = (aggregations.executionUuid as ExecutionUuidAggResult).buckets; + + return { + total, + events: buckets.map((b: ExecutionUuidAggBucket) => formatAggExecutionEventFromBucket(b)), + }; +}; + +/** + * Formats sort field into bucket_sort agg format + * @param sort + */ +export const formatSortForBucketSort = (sort: estypes.Sort) => { + return (sort as estypes.SortCombinations[]).map((s) => + Object.keys(s).reduce( + (acc, curr) => ({ ...acc, [SORT_FIELD_TO_AGG_MAPPING[curr]]: get(s, curr) }), + {} + ) + ); +}; + +/** + * Formats sort field into terms agg format + * @param sort + */ +export const formatSortForTermsSort = (sort: estypes.Sort) => { + return (sort as estypes.SortCombinations[]).map((s) => + Object.keys(s).reduce( + (acc, curr) => ({ ...acc, [SORT_FIELD_TO_AGG_MAPPING[curr]]: get(s, `${curr}.order`) }), + {} + ) + ); +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/types.ts new file mode 100644 index 00000000000000..bfe5f7d4e631b1 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/event_log/get_execution_event_aggregation/types.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; + +type AlertCounts = estypes.AggregationsMultiBucketAggregateBase & { + buckets: { + activeAlerts: estypes.AggregationsSingleBucketAggregateBase; + newAlerts: estypes.AggregationsSingleBucketAggregateBase; + recoveredAlerts: estypes.AggregationsSingleBucketAggregateBase; + }; +}; + +type ActionExecution = estypes.AggregationsTermsAggregateBase<{ + key: string; + doc_count: number; +}> & { + buckets: Array<{ key: string; doc_count: number }>; +}; + +export type ExecutionUuidAggBucket = estypes.AggregationsStringTermsBucketKeys & { + timeoutMessage: estypes.AggregationsMultiBucketBase; + ruleExecution: { + executeStartTime: estypes.AggregationsMinAggregate; + executionDuration: estypes.AggregationsMaxAggregate; + scheduleDelay: estypes.AggregationsMaxAggregate; + esSearchDuration: estypes.AggregationsMaxAggregate; + totalSearchDuration: estypes.AggregationsMaxAggregate; + numTriggeredActions: estypes.AggregationsMaxAggregate; + outcomeAndMessage: estypes.AggregationsTopHitsAggregate; + }; + alertCounts: AlertCounts; + actionExecution: { + actionOutcomes: ActionExecution; + }; + securityStatus: { + message: estypes.AggregationsTopHitsAggregate; + status: estypes.AggregationsTopHitsAggregate; + }; + securityMetrics: { + searchDuration: estypes.AggregationsMinAggregate; + indexDuration: estypes.AggregationsMinAggregate; + gapDuration: estypes.AggregationsMinAggregate; + }; +}; + +export type ExecutionUuidAggResult = + estypes.AggregationsAggregateBase & { + buckets: TBucket[]; + }; + +export interface ExecutionEventAggregationOptions { + maxExecutions: number; + page: number; + perPage: number; + sort: estypes.Sort; +} diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/build_threat_enrichment.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/build_threat_enrichment.ts index 2281381efb2ac4..bc31ee660aad82 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/build_threat_enrichment.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/build_threat_enrichment.ts @@ -7,8 +7,8 @@ import { SignalSearchResponse, SignalsEnrichment } from '../types'; import { enrichSignalThreatMatches } from './enrich_signal_threat_matches'; -import { getThreatList } from './get_threat_list'; import { BuildThreatEnrichmentOptions, GetMatchedThreats } from './types'; +import { getThreatList } from './get_threat_list'; export const buildThreatEnrichment = ({ buildRuleMessage, @@ -20,6 +20,8 @@ export const buildThreatEnrichment = ({ threatIndicatorPath, threatLanguage, threatQuery, + pitId, + reassignPitId, }: BuildThreatEnrichmentOptions): SignalsEnrichment => { const getMatchedThreats: GetMatchedThreats = async (ids) => { const matchedThreatsFilter = { @@ -46,6 +48,8 @@ export const buildThreatEnrichment = ({ _source: [`${threatIndicatorPath}.*`, 'threat.feed.*'], fields: undefined, }, + pitId, + reassignPitId, }); return threatResponse.hits.hits; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_event_signal.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_event_signal.ts index c1beb55e90a85b..faa14bcbab3090 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_event_signal.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_event_signal.ts @@ -44,9 +44,9 @@ export const createEventSignal = async ({ threatFilters, threatLanguage, threatIndex, - threatListConfig, threatIndicatorPath, - perPage, + threatPitId, + reassignThreatPitId, }: CreateEventSignalOptions): Promise => { const threatFilter = buildThreatMappingFilter({ threatMapping, @@ -77,7 +77,8 @@ export const createEventSignal = async ({ _source: [`${threatIndicatorPath}.*`, 'threat.feed.*'], fields: undefined, }, - perPage, + pitId: threatPitId, + reassignPitId: reassignThreatPitId, }); const signalMatches = getSignalMatchesFromThreatList(threatListHits); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_threat_signals.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_threat_signals.ts index eecc55a67ad52d..f02d273585ef7a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_threat_signals.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_threat_signals.ts @@ -6,6 +6,8 @@ */ import chunk from 'lodash/fp/chunk'; +import { OpenPointInTimeResponse } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; + import { getThreatList, getThreatListCount } from './get_threat_list'; import { CreateThreatSignalsOptions, @@ -19,6 +21,7 @@ import { buildExecutionIntervalValidator, combineConcurrentResults } from './uti import { buildThreatEnrichment } from './build_threat_enrichment'; import { getEventCount, getEventList } from './get_event_count'; import { getMappingFilters } from './get_mapping_filters'; +import { THREAT_PIT_KEEP_ALIVE } from '../../../../../common/cti/constants'; export const createThreatSignals = async ({ alertId, @@ -89,6 +92,16 @@ export const createThreatSignals = async ({ return results; } + let threatPitId: OpenPointInTimeResponse['id'] = ( + await services.scopedClusterClient.asCurrentUser.openPointInTime({ + index: threatIndex, + keep_alive: THREAT_PIT_KEEP_ALIVE, + }) + ).id; + const reassignThreatPitId = (newPitId: OpenPointInTimeResponse['id'] | undefined) => { + if (newPitId) threatPitId = newPitId; + }; + const threatListCount = await getThreatListCount({ esClient: services.scopedClusterClient.asCurrentUser, exceptionItems, @@ -115,6 +128,8 @@ export const createThreatSignals = async ({ threatIndicatorPath, threatLanguage, threatQuery, + pitId: threatPitId, + reassignPitId: reassignThreatPitId, }); const createSignals = async ({ @@ -188,8 +203,8 @@ export const createThreatSignals = async ({ buildRuleMessage, bulkCreate, completeRule, - currentResult: results, currentEventList: slicedChunk, + currentResult: results, eventsTelemetry, exceptionItems, filters: allEventFilters, @@ -199,21 +214,21 @@ export const createThreatSignals = async ({ logger, outputIndex, query, + reassignThreatPitId, savedId, searchAfterSize, services, threatEnrichment, + threatFilters: allThreatFilters, + threatIndex, + threatIndicatorPath, + threatLanguage, threatMapping, + threatPitId, + threatQuery, tuple, type, wrapHits, - threatQuery, - threatFilters: allThreatFilters, - threatLanguage, - threatIndex, - threatListConfig, - threatIndicatorPath, - perPage, }), }); } else { @@ -232,6 +247,8 @@ export const createThreatSignals = async ({ buildRuleMessage, perPage, threatListConfig, + pitId: threatPitId, + reassignPitId: reassignThreatPitId, }), createSignal: (slicedChunk) => @@ -263,6 +280,15 @@ export const createThreatSignals = async ({ }); } + try { + await services.scopedClusterClient.asCurrentUser.closePointInTime({ id: threatPitId }); + } catch (error) { + // Don't fail due to a bad point in time closure. We have seen failures in e2e tests during nominal operations. + logger.warn( + `Error trying to close point in time: "${threatPitId}", it will expire within "${THREAT_PIT_KEEP_ALIVE}". Error is: "${error}"` + ); + } + logger.debug(buildRuleMessage('Indicator matching rule has completed')); return results; }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/get_threat_list.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/get_threat_list.ts index 9f2fcef2f68838..93e6dccdbed33e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/get_threat_list.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/get_threat_list.ts @@ -17,22 +17,24 @@ import { /** * This should not exceed 10000 (10k) */ -export const MAX_PER_PAGE = 9000; +export const INDICATOR_PER_PAGE = 1000; export const getThreatList = async ({ esClient, query, language, index, - perPage, searchAfter, exceptionItems, threatFilters, buildRuleMessage, logger, threatListConfig, + pitId, + reassignPitId, + perPage, }: GetThreatListOptions): Promise> => { - const calculatedPerPage = perPage ?? MAX_PER_PAGE; + const calculatedPerPage = perPage ?? INDICATOR_PER_PAGE; if (calculatedPerPage > 10000) { throw new TypeError('perPage cannot exceed the size of 10000'); } @@ -58,15 +60,17 @@ export const getThreatList = async ({ ...threatListConfig, query: queryFilter, search_after: searchAfter, - sort: ['_doc', { '@timestamp': 'asc' }], + sort: ['_shard_doc', { '@timestamp': 'asc' }], }, track_total_hits: false, - ignore_unavailable: true, - index, size: calculatedPerPage, + pit: { id: pitId }, }); logger.debug(buildRuleMessage(`Retrieved indicator items of size: ${response.hits.hits.length}`)); + + reassignPitId(response.pit_id); + return response; }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/types.ts index 8beabe072c13fd..f0f2d7e1af3b59 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/types.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/types.ts @@ -18,6 +18,7 @@ import type { Type, } from '@kbn/securitysolution-io-ts-alerting-types'; import type { ExceptionListItemSchema } from '@kbn/securitysolution-io-ts-list-types'; +import { OpenPointInTimeResponse } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { ListClient } from '../../../../../../lists/server'; import { AlertInstanceContext, @@ -123,8 +124,9 @@ export interface CreateEventSignalOptions { threatLanguage: ThreatLanguageOrUndefined; threatMapping: ThreatMapping; threatQuery: ThreatQuery; - threatListConfig: ThreatListConfig; perPage?: number; + threatPitId: OpenPointInTimeResponse['id']; + reassignThreatPitId: (newPitId: OpenPointInTimeResponse['id'] | undefined) => void; } type EntryKey = 'field' | 'value'; @@ -186,6 +188,8 @@ export interface GetThreatListOptions { searchAfter: estypes.SortResults | undefined; threatFilters: unknown[]; threatListConfig: ThreatListConfig; + pitId: OpenPointInTimeResponse['id']; + reassignPitId: (newPitId: OpenPointInTimeResponse['id'] | undefined) => void; } export interface ThreatListCountOptions { @@ -236,6 +240,8 @@ export interface BuildThreatEnrichmentOptions { threatIndicatorPath: ThreatIndicatorPath; threatLanguage: ThreatLanguageOrUndefined; threatQuery: ThreatQuery; + pitId: string; + reassignPitId: (newPitId: OpenPointInTimeResponse['id'] | undefined) => void; } export interface EventsOptions { diff --git a/x-pack/plugins/session_view/public/components/process_tree/hooks.ts b/x-pack/plugins/session_view/public/components/process_tree/hooks.ts index eb1472c767c019..39c038fd8499fb 100644 --- a/x-pack/plugins/session_view/public/components/process_tree/hooks.ts +++ b/x-pack/plugins/session_view/public/components/process_tree/hooks.ts @@ -83,7 +83,7 @@ export class ProcessImpl implements Process { child.getDetails().process; // search matches or processes with alerts will never be filtered out - if (child.searchMatched || child.hasAlerts()) { + if (child.autoExpand || child.searchMatched || child.hasAlerts()) { return true; } @@ -94,11 +94,6 @@ export class ProcessImpl implements Process { return false; } - // If the process has no children and has not exec'd (fork only), we hide it. - if (child.children.length === 0 && !child.hasExec()) { - return false; - } - return true; }); } diff --git a/x-pack/plugins/session_view/public/components/process_tree/index.tsx b/x-pack/plugins/session_view/public/components/process_tree/index.tsx index 1c65eb9b3aad8b..a702bb19f8e301 100644 --- a/x-pack/plugins/session_view/public/components/process_tree/index.tsx +++ b/x-pack/plugins/session_view/public/components/process_tree/index.tsx @@ -145,14 +145,16 @@ export const ProcessTree = ({ if (processEl) { processEl.prepend(selectionAreaEl); - const cTop = scrollerRef.current.scrollTop; - const cBottom = cTop + scrollerRef.current.clientHeight; + const { height: elHeight, y: elTop } = processEl.getBoundingClientRect(); + const { y: viewPortElTop, height: viewPortElHeight } = + scrollerRef.current.getBoundingClientRect(); - const eTop = processEl.offsetTop; - const eBottom = eTop + processEl.clientHeight; - const isVisible = eTop >= cTop && eBottom <= cBottom; + const viewPortElBottom = viewPortElTop + viewPortElHeight; + const elBottom = elTop + elHeight; + const isVisible = elBottom >= viewPortElTop && elTop <= viewPortElBottom; - if (!isVisible) { + // jest will die when calling scrollIntoView (perhaps not part of the DOM it executes under) + if (!isVisible && processEl.scrollIntoView) { processEl.scrollIntoView({ block: 'center' }); } } @@ -209,6 +211,7 @@ export const ProcessTree = ({ onShowAlertDetails={onShowAlertDetails} timeStampOn={timeStampOn} verboseModeOn={verboseModeOn} + searchResults={searchResults} /> )}
void; - showGroupLeadersOnly: boolean; - childCount: number; -}) => { - const groupLeaderCount = process.getChildren(false).length; - const sameGroupCount = childCount - groupLeaderCount; - const { button, buttonArrow, expandedIcon } = useButtonStyles({ - isExpanded: !showGroupLeadersOnly, - }); - - if (sameGroupCount > 0) { - return ( - - -

- } - > - - - - - - ); - } - return null; -}; - export const AlertButton = ({ isExpanded, onToggle, diff --git a/x-pack/plugins/session_view/public/components/process_tree_node/index.tsx b/x-pack/plugins/session_view/public/components/process_tree_node/index.tsx index b38b7335fe27e6..d2e5b1b8995539 100644 --- a/x-pack/plugins/session_view/public/components/process_tree_node/index.tsx +++ b/x-pack/plugins/session_view/public/components/process_tree_node/index.tsx @@ -42,6 +42,7 @@ export interface ProcessDeps { selectedProcessId?: string; timeStampOn?: boolean; verboseModeOn?: boolean; + searchResults?: Process[]; scrollerRef: RefObject; onChangeJumpToEventVisibility: (isVisible: boolean, isAbove: boolean) => void; onShowAlertDetails: (alertUuid: string) => void; @@ -60,6 +61,7 @@ export function ProcessTreeNode({ selectedProcessId, timeStampOn = true, verboseModeOn = true, + searchResults, scrollerRef, onChangeJumpToEventVisibility, onShowAlertDetails, @@ -171,6 +173,18 @@ export function ProcessTreeNode({ } }, [hasExec, process.parent]); + const children = useMemo(() => { + if (searchResults) { + // noop + // Only used to break cache on this memo when search changes. We need this ref + // to avoid complaints from the useEffect dependency eslint rule. + // This fixes an issue when verbose mode is OFF and there are matching results on + // hidden processes. + } + + return process.getChildren(verboseModeOn); + }, [process, verboseModeOn, searchResults]); + if (!processDetails?.process) { return null; } @@ -187,9 +201,7 @@ export function ProcessTreeNode({ start, } = processDetails.process; - const children = process.getChildren(verboseModeOn); - const childCount = process.getChildren(true).length; - const shouldRenderChildren = childrenExpanded && children && children.length > 0; + const shouldRenderChildren = childrenExpanded && children?.length > 0; const childrenTreeDepth = depth + 1; const showUserEscalation = user.id !== parent.user.id; @@ -261,7 +273,7 @@ export function ProcessTreeNode({ {user.name} )} - {!isSessionLeader && childCount > 0 && ( + {!isSessionLeader && children.length > 0 && ( )} {alerts.length > 0 && ( @@ -298,6 +310,7 @@ export function ProcessTreeNode({ selectedProcessId={selectedProcessId} timeStampOn={timeStampOn} verboseModeOn={verboseModeOn} + searchResults={searchResults} scrollerRef={scrollerRef} onChangeJumpToEventVisibility={onChangeJumpToEventVisibility} onShowAlertDetails={onShowAlertDetails} diff --git a/x-pack/plugins/spaces/public/space_selector/__snapshots__/space_selector.test.tsx.snap b/x-pack/plugins/spaces/public/space_selector/__snapshots__/space_selector.test.tsx.snap index a9fd636776a4fe..294e183d183d83 100644 --- a/x-pack/plugins/spaces/public/space_selector/__snapshots__/space_selector.test.tsx.snap +++ b/x-pack/plugins/spaces/public/space_selector/__snapshots__/space_selector.test.tsx.snap @@ -1,66 +1,60 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`it renders without crashing 1`] = ` - - - + + + +

- - - - - -

- -

- - -

- -

- - - + - - - - - - +

+ +

+ + + + + + `; diff --git a/x-pack/plugins/spaces/public/space_selector/components/space_card.tsx b/x-pack/plugins/spaces/public/space_selector/components/space_card.tsx index 214659169e72d1..5b1182c99029dc 100644 --- a/x-pack/plugins/spaces/public/space_selector/components/space_card.tsx +++ b/x-pack/plugins/spaces/public/space_selector/components/space_card.tsx @@ -42,7 +42,7 @@ function renderSpaceAvatar(space: Space) { // not announcing space name here because the title of the EuiCard that the SpaceAvatar lives in is already // announcing it. See https://github.com/elastic/kibana/issues/27748 return ( - }> + }> ); diff --git a/x-pack/plugins/spaces/public/space_selector/space_selector.scss b/x-pack/plugins/spaces/public/space_selector/space_selector.scss index b888fb765b884f..9d07d62564eb83 100644 --- a/x-pack/plugins/spaces/public/space_selector/space_selector.scss +++ b/x-pack/plugins/spaces/public/space_selector/space_selector.scss @@ -3,37 +3,26 @@ } .spcSpaceSelector__pageContent { - background-color: transparent; - box-shadow: none; - border: none; - text-align: center; position: relative; z-index: 10; } -.spcSpaceSelector__heading { - flex-direction: column; - flex-shrink: 0; - position: relative; - padding: $euiSizeXL; - z-index: 10; -} - -.spcSpaceSelector__logo { - @include kibanaCircleLogo; - @include euiBottomShadowMedium; - margin-bottom: $euiSizeXL; +// Fix forced focus outline on text that isn't a link to just be an underline +.spcSpaceSelector__pageHeader { + &:focus { + outline: none; + text-decoration: underline; + } } .spcSpaceSelector__searchHolder { width: $euiFormMaxWidth; // make sure it's as wide as our default form element width max-width: 100%; + margin-inline: auto; } .spcSpaceSelector__errorPanel { - position: relative; - margin: auto; - padding-left: $euiSizeXL; - padding-right: $euiSizeXL; + text-align: center; + margin-inline: auto; max-width: 700px; } diff --git a/x-pack/plugins/spaces/public/space_selector/space_selector.tsx b/x-pack/plugins/spaces/public/space_selector/space_selector.tsx index 438822de361340..f785d5dbf36776 100644 --- a/x-pack/plugins/spaces/public/space_selector/space_selector.tsx +++ b/x-pack/plugins/spaces/public/space_selector/space_selector.tsx @@ -9,17 +9,11 @@ import './space_selector.scss'; import { EuiFieldSearch, - EuiFlexGroup, - EuiFlexItem, - EuiIcon, EuiLoadingSpinner, - EuiPage, - EuiPageBody, - EuiPageContent, - EuiPageHeader, EuiPanel, EuiSpacer, EuiText, + EuiTextColor, EuiTitle, } from '@elastic/eui'; import React, { Component, Fragment } from 'react'; @@ -27,9 +21,13 @@ import ReactDOM from 'react-dom'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; +import { KibanaSolutionAvatar } from '@kbn/shared-ux-components'; import type { AppMountParameters, CoreStart } from 'src/core/public'; -import { KibanaThemeProvider } from '../../../../../src/plugins/kibana_react/public'; +import { + KibanaPageTemplate, + KibanaThemeProvider, +} from '../../../../../src/plugins/kibana_react/public'; import type { Space } from '../../common'; import { SPACE_SEARCH_COUNT_THRESHOLD } from '../../common/constants'; import type { SpacesManager } from '../spaces_manager'; @@ -106,84 +104,90 @@ export class SpaceSelector extends Component { } return ( - - - - - - - - - -

- -

- - -

- -

- - - - - {this.getSearchField()} - - - - - {this.state.loading && } - - {!this.state.loading && ( - - )} - - {!this.state.loading && !this.state.error && filteredSpaces.length === 0 && ( - - - + + + + + +

+ +

+ +

+ +

+ + + + + {this.getSearchField()} + + + + {this.state.loading && } + + {!this.state.loading && ( + + )} + + {!this.state.loading && !this.state.error && filteredSpaces.length === 0 && ( + + + + +

+ {i18n.translate( + 'xpack.spaces.spaceSelector.noSpacesMatchSearchCriteriaDescription', + { + defaultMessage: 'No spaces match {searchTerm}', + values: { searchTerm: `"${this.state.searchTerm}"` }, + } + )} +

+ + + + )} + + {!this.state.loading && this.state.error && ( + + + + +

+ +

+

- - - )} - - {!this.state.loading && this.state.error && ( - - - - - - - - - - - - )} - - - +

+ + + + )} + ); } @@ -191,19 +195,20 @@ export class SpaceSelector extends Component { if (!this.state.spaces || this.state.spaces.length < SPACE_SEARCH_COUNT_THRESHOLD) { return null; } + + const inputLabel = i18n.translate('xpack.spaces.spaceSelector.findSpacePlaceholder', { + defaultMessage: 'Find a space', + }); + return ( - - { - - } - +
+ +
); }; diff --git a/x-pack/plugins/translations/translations/fr-FR.json b/x-pack/plugins/translations/translations/fr-FR.json index 9056d2e6053b37..63bc9f34c8a112 100644 --- a/x-pack/plugins/translations/translations/fr-FR.json +++ b/x-pack/plugins/translations/translations/fr-FR.json @@ -1616,7 +1616,6 @@ "data.kueryAutocomplete.equalOperatorDescription.equalsText": "égale", "data.kueryAutocomplete.existOperatorDescription": "{exists} sous un certain format", "data.kueryAutocomplete.existOperatorDescription.existsText": "existe", - "data.kueryAutocomplete.filterResultsDescription": "Filtrer les résultats contenant {fieldName}", "data.kueryAutocomplete.greaterThanOperatorDescription": "est {greaterThan} une certaine valeur", "data.kueryAutocomplete.greaterThanOperatorDescription.greaterThanText": "supérieur à", "data.kueryAutocomplete.greaterThanOrEqualOperatorDescription": "est {greaterThanOrEqualTo} une certaine valeur", @@ -20776,15 +20775,10 @@ "xpack.securitySolution.detectionEngine.ruleDetails.deletedRule": "Règle supprimée", "xpack.securitySolution.detectionEngine.ruleDetails.exceptionsTab": "Exceptions", "xpack.securitySolution.detectionEngine.ruleDetails.experimentalDescription": "Expérimental", - "xpack.securitySolution.detectionEngine.ruleDetails.failureHistoryTab": "Historique des échecs", - "xpack.securitySolution.detectionEngine.ruleDetails.lastFiveErrorsTitle": "Cinq dernières erreurs", "xpack.securitySolution.detectionEngine.ruleDetails.pageTitle": "Détails de la règle", "xpack.securitySolution.detectionEngine.ruleDetails.ruleCreationDescription": "Créé par : {by} le {date}", "xpack.securitySolution.detectionEngine.ruleDetails.ruleUpdateDescription": "Mis à jour par : {by} le {date}", - "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedAtColumn": "Échoué à", "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedDescription": "Échoué", - "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedMsgColumn": "Message échoué", - "xpack.securitySolution.detectionEngine.ruleDetails.statusTypeColumn": "Type", "xpack.securitySolution.detectionEngine.ruleDetails.unknownDescription": "Inconnu", "xpack.securitySolution.detectionEngine.rules.aboutRuleTitle": "À propos de la règle", "xpack.securitySolution.detectionEngine.rules.addNewRuleTitle": "Créer une nouvelle règle", @@ -23321,7 +23315,6 @@ "xpack.spaces.spaceSelector.contactSysAdminDescription": "Contactez votre administrateur système.", "xpack.spaces.spaceSelector.errorLoadingSpacesDescription": "Erreur lors du chargement des espaces ({message})", "xpack.spaces.spaceSelector.findSpacePlaceholder": "Rechercher un espace", - "xpack.spaces.spaceSelector.noSpacesMatchSearchCriteriaDescription": "Aucun espace ne correspond aux critères de recherche", "xpack.spaces.spaceSelector.selectSpacesTitle": "Sélectionner votre espace", "xpack.spaces.spacesTitle": "Espaces", "xpack.spaces.uiApi.errorBoundaryToastMessage": "Rechargez la page pour continuer.", diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json index e2e106515d4084..338cef102027f2 100644 --- a/x-pack/plugins/translations/translations/ja-JP.json +++ b/x-pack/plugins/translations/translations/ja-JP.json @@ -1231,7 +1231,6 @@ "controls.optionsList.editor.allowMultiselectTitle": "ドロップダウンでの複数選択を許可", "controls.optionsList.editor.dataViewTitle": "データビュー", "controls.optionsList.editor.fieldTitle": "フィールド", - "controls.optionsList.editor.indexPatternTitle": "インデックスパターン", "controls.optionsList.editor.noDataViewTitle": "データビューを選択", "controls.optionsList.errors.dataViewNotFound": "データビュー{dataViewId}が見つかりませんでした", "controls.optionsList.popover.allOptionsTitle": "すべてのオプションを表示", @@ -1939,7 +1938,6 @@ "data.kueryAutocomplete.equalOperatorDescription.equalsText": "一致する", "data.kueryAutocomplete.existOperatorDescription": "いずれかの形式中に{exists}", "data.kueryAutocomplete.existOperatorDescription.existsText": "存在する", - "data.kueryAutocomplete.filterResultsDescription": "{fieldName}を含む結果をフィルタリング", "data.kueryAutocomplete.greaterThanOperatorDescription": "が一部の値{greaterThan}", "data.kueryAutocomplete.greaterThanOperatorDescription.greaterThanText": "より大きい", "data.kueryAutocomplete.greaterThanOrEqualOperatorDescription": "が一部の値{greaterThanOrEqualTo}", @@ -6959,7 +6957,6 @@ "xpack.apm.deprecations.steps.switch": "［Elasticエージェントに切り替える］をクリックします。手順が案内されます。", "xpack.apm.emptyMessage.noDataFoundDescription": "別の時間範囲を試すか検索フィルターをリセットしてください。", "xpack.apm.emptyMessage.noDataFoundLabel": "データが見つかりません。", - "xpack.apm.environmentsSelectCustomOptionText": "新しい環境として\\{searchValue\\}を追加", "xpack.apm.environmentsSelectPlaceholder": "環境を選択", "xpack.apm.error.prompt.body": "詳細はブラウザの開発者コンソールをご確認ください。", "xpack.apm.error.prompt.title": "申し訳ございませんが、エラーが発生しました :（", @@ -7293,7 +7290,6 @@ "xpack.apm.serviceMap.viewFullMap": "サービスの全体マップを表示", "xpack.apm.serviceMap.zoomIn": "ズームイン", "xpack.apm.serviceMap.zoomOut": "ズームアウト", - "xpack.apm.serviceNamesSelectCustomOptionText": "新しいサービス名として\\{searchValue\\}を追加", "xpack.apm.serviceNamesSelectPlaceholder": "サービス名を選択", "xpack.apm.serviceNodeMetrics.containerId": "コンテナー ID", "xpack.apm.serviceNodeMetrics.host": "ホスト", @@ -7651,7 +7647,6 @@ "xpack.apm.transactionsTable.cardinalityWarning.title": "このビューには、報告されたトランザクションのサブセットが表示されます。", "xpack.apm.transactionsTable.linkText": "トランザクションを表示", "xpack.apm.transactionsTable.title": "トランザクション", - "xpack.apm.transactionTypesSelectCustomOptionText": "新しいトランザクションタイプとして\\{searchValue\\}を追加", "xpack.apm.transactionTypesSelectPlaceholder": "トランザクションタイプを選択", "xpack.apm.tutorial.agent_config.choosePolicy.helper": "選択したポリシー構成を下のスニペットに追加します。", "xpack.apm.tutorial.agent_config.choosePolicyLabel": "ポリシーを選択", @@ -23759,15 +23754,10 @@ "xpack.securitySolution.detectionEngine.ruleDetails.deletedRule": "削除されたルール", "xpack.securitySolution.detectionEngine.ruleDetails.exceptionsTab": "例外", "xpack.securitySolution.detectionEngine.ruleDetails.experimentalDescription": "テクニカルプレビュー", - "xpack.securitySolution.detectionEngine.ruleDetails.failureHistoryTab": "エラー履歴", - "xpack.securitySolution.detectionEngine.ruleDetails.lastFiveErrorsTitle": "最後の5件のエラー", "xpack.securitySolution.detectionEngine.ruleDetails.pageTitle": "ルール詳細", "xpack.securitySolution.detectionEngine.ruleDetails.ruleCreationDescription": "作成者: {by} 日付: {date}", "xpack.securitySolution.detectionEngine.ruleDetails.ruleUpdateDescription": "更新者：{by} 日付：{date}", - "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedAtColumn": "失敗", "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedDescription": "失敗", - "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedMsgColumn": "失敗メッセージ", - "xpack.securitySolution.detectionEngine.ruleDetails.statusTypeColumn": "型", "xpack.securitySolution.detectionEngine.ruleDetails.unknownDescription": "不明", "xpack.securitySolution.detectionEngine.rules.aboutRuleTitle": "ルールについて", "xpack.securitySolution.detectionEngine.rules.addNewRuleTitle": "新規ルールを作成", @@ -26650,7 +26640,6 @@ "xpack.spaces.spaceSelector.contactSysAdminDescription": "システム管理者にお問い合わせください。", "xpack.spaces.spaceSelector.errorLoadingSpacesDescription": "スペースの読み込みエラー（{message}）", "xpack.spaces.spaceSelector.findSpacePlaceholder": "スペースを検索", - "xpack.spaces.spaceSelector.noSpacesMatchSearchCriteriaDescription": "検索条件に一致するスペースがありません", "xpack.spaces.spaceSelector.selectSpacesTitle": "スペースの選択", "xpack.spaces.spacesTitle": "スペース", "xpack.spaces.uiApi.errorBoundaryToastMessage": "続行するにはページを再読み込みしてください。", diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json index 0ddb9de4feb123..615229a857b110 100644 --- a/x-pack/plugins/translations/translations/zh-CN.json +++ b/x-pack/plugins/translations/translations/zh-CN.json @@ -1235,7 +1235,6 @@ "controls.optionsList.editor.allowMultiselectTitle": "下拉列表中允许多选", "controls.optionsList.editor.dataViewTitle": "数据视图", "controls.optionsList.editor.fieldTitle": "字段", - "controls.optionsList.editor.indexPatternTitle": "索引模式", "controls.optionsList.editor.noDataViewTitle": "选择数据视图", "controls.optionsList.errors.dataViewNotFound": "找不到数据视图：{dataViewId}", "controls.optionsList.popover.allOptionsTitle": "显示所有选项", @@ -1944,7 +1943,6 @@ "data.kueryAutocomplete.equalOperatorDescription.equalsText": "等于", "data.kueryAutocomplete.existOperatorDescription": "以任意形式{exists}", "data.kueryAutocomplete.existOperatorDescription.existsText": "存在", - "data.kueryAutocomplete.filterResultsDescription": "筛选包含 {fieldName} 的结果", "data.kueryAutocomplete.greaterThanOperatorDescription": "{greaterThan}某一值", "data.kueryAutocomplete.greaterThanOperatorDescription.greaterThanText": "大于", "data.kueryAutocomplete.greaterThanOrEqualOperatorDescription": "{greaterThanOrEqualTo}某一值", @@ -6972,7 +6970,6 @@ "xpack.apm.deprecations.steps.switch": "单击“切换到 Elastic 代理”。将指导您完成此过程", "xpack.apm.emptyMessage.noDataFoundDescription": "尝试其他时间范围或重置搜索筛选。", "xpack.apm.emptyMessage.noDataFoundLabel": "未找到任何数据。", - "xpack.apm.environmentsSelectCustomOptionText": "将 \\{searchValue\\} 添加为新环境", "xpack.apm.environmentsSelectPlaceholder": "选择环境", "xpack.apm.error.prompt.body": "有关详情，请查看您的浏览器开发者控制台。", "xpack.apm.error.prompt.title": "抱歉，发生错误 :(", @@ -7308,7 +7305,6 @@ "xpack.apm.serviceMap.viewFullMap": "查看完整的服务地图", "xpack.apm.serviceMap.zoomIn": "放大", "xpack.apm.serviceMap.zoomOut": "缩小", - "xpack.apm.serviceNamesSelectCustomOptionText": "将 \\{searchValue\\} 添加为新服务名称", "xpack.apm.serviceNamesSelectPlaceholder": "选择服务名称", "xpack.apm.serviceNodeMetrics.containerId": "容器 ID", "xpack.apm.serviceNodeMetrics.host": "主机", @@ -7667,7 +7663,6 @@ "xpack.apm.transactionsTable.cardinalityWarning.title": "此视图显示已报告事务的子集。", "xpack.apm.transactionsTable.linkText": "查看事务", "xpack.apm.transactionsTable.title": "事务", - "xpack.apm.transactionTypesSelectCustomOptionText": "将 \\{searchValue\\} 添加为新事务类型", "xpack.apm.transactionTypesSelectPlaceholder": "选择事务类型", "xpack.apm.tutorial.agent_config.choosePolicy.helper": "将选定的策略配置添加到下面的代码片段。", "xpack.apm.tutorial.agent_config.choosePolicyLabel": "选择策略", @@ -23786,15 +23781,10 @@ "xpack.securitySolution.detectionEngine.ruleDetails.deletedRule": "已删除规则", "xpack.securitySolution.detectionEngine.ruleDetails.exceptionsTab": "例外", "xpack.securitySolution.detectionEngine.ruleDetails.experimentalDescription": "技术预览", - "xpack.securitySolution.detectionEngine.ruleDetails.failureHistoryTab": "失败历史记录", - "xpack.securitySolution.detectionEngine.ruleDetails.lastFiveErrorsTitle": "上五个错误", "xpack.securitySolution.detectionEngine.ruleDetails.pageTitle": "规则详情", "xpack.securitySolution.detectionEngine.ruleDetails.ruleCreationDescription": "由 {by} 于 {date}创建", "xpack.securitySolution.detectionEngine.ruleDetails.ruleUpdateDescription": "由 {by} 于 {date}更新", - "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedAtColumn": "失败于", "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedDescription": "失败", - "xpack.securitySolution.detectionEngine.ruleDetails.statusFailedMsgColumn": "失败消息", - "xpack.securitySolution.detectionEngine.ruleDetails.statusTypeColumn": "类型", "xpack.securitySolution.detectionEngine.ruleDetails.unknownDescription": "未知", "xpack.securitySolution.detectionEngine.rules.aboutRuleTitle": "关于规则", "xpack.securitySolution.detectionEngine.rules.addNewRuleTitle": "创建新规则", @@ -26679,7 +26669,6 @@ "xpack.spaces.spaceSelector.contactSysAdminDescription": "请联系您的系统管理员。", "xpack.spaces.spaceSelector.errorLoadingSpacesDescription": "加载工作区时出错 ({message})", "xpack.spaces.spaceSelector.findSpacePlaceholder": "查找工作区", - "xpack.spaces.spaceSelector.noSpacesMatchSearchCriteriaDescription": "没有匹配搜索条件的空间", "xpack.spaces.spaceSelector.selectSpacesTitle": "选择您的空间", "xpack.spaces.spacesTitle": "工作区", "xpack.spaces.uiApi.errorBoundaryToastMessage": "重新加载页面以继续。", diff --git a/x-pack/plugins/triggers_actions_ui/common/experimental_features.ts b/x-pack/plugins/triggers_actions_ui/common/experimental_features.ts index fa848d56e0113b..c3ae062d765235 100644 --- a/x-pack/plugins/triggers_actions_ui/common/experimental_features.ts +++ b/x-pack/plugins/triggers_actions_ui/common/experimental_features.ts @@ -13,7 +13,7 @@ export type ExperimentalFeatures = typeof allowedExperimentalValues; */ export const allowedExperimentalValues = Object.freeze({ rulesListDatagrid: true, - rulesDetailLogs: false, + rulesDetailLogs: true, }); type ExperimentalConfigKeys = Array; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/constants/index.ts b/x-pack/plugins/triggers_actions_ui/public/application/constants/index.ts index 77282f834f9fde..0058147ca0d054 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/constants/index.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/constants/index.ts @@ -38,3 +38,35 @@ export enum SORT_ORDERS { export const DEFAULT_SEARCH_PAGE_SIZE: number = 10; export const DEFAULT_RULE_INTERVAL = '1m'; + +export const RULE_EXECUTION_LOG_COLUMN_IDS = [ + 'id', + 'timestamp', + 'execution_duration', + 'status', + 'message', + 'num_active_alerts', + 'num_new_alerts', + 'num_recovered_alerts', + 'num_triggered_actions', + 'num_succeeded_actions', + 'num_errored_actions', + 'total_search_duration', + 'es_search_duration', + 'schedule_delay', + 'timed_out', +] as const; + +export const RULE_EXECUTION_LOG_DURATION_COLUMNS = [ + 'execution_duration', + 'total_search_duration', + 'es_search_duration', + 'schedule_delay', +]; + +export const RULE_EXECUTION_DEFAULT_INITIAL_VISIBLE_COLUMNS = [ + 'timestamp', + 'execution_duration', + 'status', + 'message', +]; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/monitoring_utils.test.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/monitoring_utils.test.ts index 2ac04ffd6eaaf1..7f06baf8698f61 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/lib/monitoring_utils.test.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/monitoring_utils.test.ts @@ -19,7 +19,9 @@ describe('monitoring_utils', () => { it('should return a formatted duration', () => { expect(getFormattedDuration(0)).toEqual('00:00'); expect(getFormattedDuration(100.111)).toEqual('00:00'); + expect(getFormattedDuration(500)).toEqual('00:01'); expect(getFormattedDuration(50000)).toEqual('00:50'); + expect(getFormattedDuration(59900)).toEqual('01:00'); expect(getFormattedDuration(500000)).toEqual('08:20'); expect(getFormattedDuration(5000000)).toEqual('83:20'); expect(getFormattedDuration(50000000)).toEqual('833:20'); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/monitoring_utils.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/monitoring_utils.ts index f5bec630561039..a71d7b8f8efdd3 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/lib/monitoring_utils.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/monitoring_utils.ts @@ -16,10 +16,21 @@ export function getFormattedDuration(value: number) { if (!value) { return '00:00'; } + const duration = moment.duration(value); - const minutes = Math.floor(duration.asMinutes()).toString().padStart(2, '0'); - const seconds = duration.seconds().toString().padStart(2, '0'); - return `${minutes}:${seconds}`; + let minutes = Math.floor(duration.asMinutes()); + let seconds = duration.seconds(); + const ms = duration.milliseconds(); + + if (ms >= 500) { + seconds += 1; + if (seconds === 60) { + seconds = 0; + minutes += 1; + } + } + + return `${minutes.toString().padStart(2, '0')}:${seconds.toString().padStart(2, '0')}`; } export function getFormattedMilliseconds(value: number) { diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/index.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/index.ts index 75e2bdc8b4a2bf..89ede79f4a21da 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/index.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/index.ts @@ -19,6 +19,8 @@ export { muteRule, muteRules } from './mute'; export { loadRuleTypes } from './rule_types'; export { loadRules } from './rules'; export { loadRuleState } from './state'; +export type { LoadExecutionLogAggregationsProps } from './load_execution_log_aggregations'; +export { loadExecutionLogAggregations } from './load_execution_log_aggregations'; export { unmuteAlertInstance } from './unmute_alert'; export { unmuteRule, unmuteRules } from './unmute'; export { updateRule } from './update'; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.test.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.test.ts new file mode 100644 index 00000000000000..c323f0d4fa1890 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.test.ts @@ -0,0 +1,96 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { httpServiceMock } from '../../../../../../../src/core/public/mocks'; +import { loadExecutionLogAggregations, SortField } from './load_execution_log_aggregations'; + +const http = httpServiceMock.createStartContract(); + +const mockResponse = { + data: [ + { + duration_ms: 50, + es_search_duration_ms: 1, + id: '13af2138-1c9d-4d34-95c1-c25fbfbb8eeb', + message: "rule executed: .index-threshold:c8f2ccb0-aac4-11ec-a5ae-2101bb96406d: 'test'", + num_active_alerts: 0, + num_errored_actions: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_succeeded_actions: 0, + num_triggered_actions: 0, + schedule_delay_ms: 1623, + status: 'success', + timed_out: false, + timestamp: '2022-03-23T16:17:53.482Z', + total_search_duration_ms: 4, + }, + ], + total: 5, +}; + +describe('loadExecutionLogAggregations', () => { + test('should call load execution log aggregation API', async () => { + http.get.mockResolvedValueOnce(mockResponse); + + const sortTimestamp = { + timestamp: { + order: 'asc', + }, + } as SortField; + + const result = await loadExecutionLogAggregations({ + id: 'test-id', + dateStart: '2022-03-23T16:17:53.482Z', + dateEnd: '2022-03-23T16:17:53.482Z', + filter: ['success', 'unknown'], + perPage: 10, + page: 0, + sort: [sortTimestamp], + http, + }); + + expect(result).toEqual({ + ...mockResponse, + data: [ + { + execution_duration: 50, + es_search_duration: 1, + id: '13af2138-1c9d-4d34-95c1-c25fbfbb8eeb', + message: "rule executed: .index-threshold:c8f2ccb0-aac4-11ec-a5ae-2101bb96406d: 'test'", + num_active_alerts: 0, + num_errored_actions: 0, + num_new_alerts: 0, + num_recovered_alerts: 0, + num_succeeded_actions: 0, + num_triggered_actions: 0, + schedule_delay: 1623, + status: 'success', + timed_out: false, + timestamp: '2022-03-23T16:17:53.482Z', + total_search_duration: 4, + }, + ], + }); + + expect(http.get.mock.calls[0]).toMatchInlineSnapshot(` + Array [ + "/internal/alerting/rule/test-id/_execution_log", + Object { + "query": Object { + "date_end": "2022-03-23T16:17:53.482Z", + "date_start": "2022-03-23T16:17:53.482Z", + "filter": "success OR unknown", + "page": 1, + "per_page": 10, + "sort": "[{\\"timestamp\\":{\\"order\\":\\"asc\\"}}]", + }, + }, + ] + `); + }); +}); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.ts new file mode 100644 index 00000000000000..2dceac6dfd7d9b --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.ts @@ -0,0 +1,97 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +/* eslint-disable @typescript-eslint/naming-convention */ + +import { HttpSetup } from 'kibana/public'; +import type { SortOrder } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { INTERNAL_BASE_ALERTING_API_PATH } from '../../constants'; + +import { + IExecutionLogResult, + IExecutionLog, + ExecutionLogSortFields, +} from '../../../../../alerting/common'; +import { AsApiContract, RewriteRequestCase } from '../../../../../actions/common'; + +const getRenamedLog = (data: IExecutionLog) => { + const { + duration_ms, + total_search_duration_ms, + es_search_duration_ms, + schedule_delay_ms, + ...rest + } = data; + + return { + execution_duration: data.duration_ms, + total_search_duration: data.total_search_duration_ms, + es_search_duration: data.es_search_duration_ms, + schedule_delay: data.schedule_delay_ms, + ...rest, + }; +}; + +const rewriteBodyRes: RewriteRequestCase = ({ data, total }: any) => ({ + data: data.map((log: IExecutionLog) => getRenamedLog(log)), + total, +}); + +const getFilter = (filter: string[] | undefined) => { + if (!filter || !filter.length) { + return; + } + return filter.join(' OR '); +}; + +export type SortField = Record< + ExecutionLogSortFields, + { + order: SortOrder; + } +>; + +export interface LoadExecutionLogAggregationsProps { + id: string; + dateStart: string; + dateEnd?: string; + filter?: string[]; + perPage?: number; + page?: number; + sort?: SortField[]; +} + +export const loadExecutionLogAggregations = async ({ + id, + http, + dateStart, + dateEnd, + filter, + perPage = 10, + page = 0, + sort = [], +}: LoadExecutionLogAggregationsProps & { http: HttpSetup }) => { + const sortField: any[] = sort; + + const result = await http.get>( + `${INTERNAL_BASE_ALERTING_API_PATH}/rule/${id}/_execution_log`, + { + query: { + date_start: dateStart, + date_end: dateEnd, + filter: getFilter(filter), + per_page: perPage, + // Need to add the + 1 for pages because APIs are 1 indexed, + // whereas data grid sorts are 0 indexed. + page: page + 1, + sort: sortField.length ? JSON.stringify(sortField) : undefined, + }, + } + ); + + return rewriteBodyRes(result); +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.test.tsx index d0950c0c75fc22..1eefd329d2a4d1 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.test.tsx @@ -10,6 +10,8 @@ import { shallow, mount } from 'enzyme'; import uuid from 'uuid'; import { withBulkRuleOperations, ComponentOpts } from './with_bulk_rule_api_operations'; import * as ruleApi from '../../../lib/rule_api'; +import { SortField } from '../../../lib/rule_api/load_execution_log_aggregations'; + import { Rule } from '../../../../types'; import { useKibana } from '../../../../common/lib/kibana'; jest.mock('../../../../common/lib/kibana'); @@ -37,6 +39,7 @@ describe('with_bulk_rule_api_operations', () => { expect(typeof props.loadRule).toEqual('function'); expect(typeof props.loadRuleTypes).toEqual('function'); expect(typeof props.resolveRule).toEqual('function'); + expect(typeof props.loadExecutionLogAggregations).toEqual('function'); return
; }; @@ -246,6 +249,40 @@ describe('with_bulk_rule_api_operations', () => { expect(ruleApi.loadRuleTypes).toHaveBeenCalledTimes(1); expect(ruleApi.loadRuleTypes).toHaveBeenCalledWith({ http }); }); + + it('loadExecutionLogAggregations calls the loadExecutionLogAggregations api', () => { + const { http } = useKibanaMock().services; + + const sortTimestamp = { + timestamp: { + order: 'asc', + }, + } as SortField; + + const callProps = { + id: 'test-id', + dateStart: '2022-03-23T16:17:53.482Z', + dateEnd: '2022-03-23T16:17:53.482Z', + filter: ['success', 'unknown'], + perPage: 10, + page: 0, + sort: [sortTimestamp], + }; + + const ComponentToExtend = ({ loadExecutionLogAggregations }: ComponentOpts) => { + return ; + }; + + const ExtendedComponent = withBulkRuleOperations(ComponentToExtend); + const component = mount(); + component.find('button').simulate('click'); + + expect(ruleApi.loadExecutionLogAggregations).toHaveBeenCalledTimes(1); + expect(ruleApi.loadExecutionLogAggregations).toHaveBeenCalledWith({ + ...callProps, + http, + }); + }); }); function mockRule(overloads: Partial = {}): Rule { diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.tsx index d9bafe5816d69a..a9c9dfa72279c4 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/with_bulk_rule_api_operations.tsx @@ -33,7 +33,10 @@ import { loadRuleTypes, alertingFrameworkHealth, resolveRule, + loadExecutionLogAggregations, + LoadExecutionLogAggregationsProps, } from '../../../lib/rule_api'; +import { IExecutionLogResult } from '../../../../../../alerting/common'; import { useKibana } from '../../../../common/lib/kibana'; export interface ComponentOpts { @@ -59,6 +62,9 @@ export interface ComponentOpts { loadRuleState: (id: Rule['id']) => Promise; loadRuleSummary: (id: Rule['id'], numberOfExecutions?: number) => Promise; loadRuleTypes: () => Promise; + loadExecutionLogAggregations: ( + props: LoadExecutionLogAggregationsProps + ) => Promise; getHealth: () => Promise; resolveRule: (id: Rule['id']) => Promise; } @@ -131,6 +137,12 @@ export function withBulkRuleOperations( loadRuleSummary({ http, ruleId, numberOfExecutions }) } loadRuleTypes={async () => loadRuleTypes({ http })} + loadExecutionLogAggregations={async (loadProps: LoadExecutionLogAggregationsProps) => + loadExecutionLogAggregations({ + ...loadProps, + http, + }) + } resolveRule={async (ruleId: Rule['id']) => resolveRule({ http, ruleId })} getHealth={async () => alertingFrameworkHealth({ http })} /> diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/alert_muted_switch.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/alert_muted_switch.tsx index 3f236ea25a19bd..b63300a83fcbcf 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/alert_muted_switch.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/alert_muted_switch.tsx @@ -8,7 +8,7 @@ import React, { useState } from 'react'; import { EuiSwitch, EuiLoadingSpinner } from '@elastic/eui'; -import { AlertListItem } from './rule'; +import { AlertListItem } from './types'; interface ComponentOpts { alert: AlertListItem; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.test.tsx index ac103f113a8f1f..737501f444300f 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.test.tsx @@ -10,13 +10,20 @@ import uuid from 'uuid'; import { shallow } from 'enzyme'; import { mountWithIntl, nextTick } from '@kbn/test-jest-helpers'; import { act } from 'react-dom/test-utils'; -import { RuleComponent, AlertListItem, alertToListItem } from './rule'; +import { RuleComponent, alertToListItem } from './rule'; +import { AlertListItem } from './types'; +import { RuleAlertList } from './rule_alert_list'; import { Rule, RuleSummary, AlertStatus, RuleType } from '../../../../types'; -import { EuiBasicTable } from '@elastic/eui'; import { ExecutionDurationChart } from '../../common/components/execution_duration_chart'; jest.mock('../../../../common/lib/kibana'); +jest.mock('../../../../common/get_experimental_features', () => ({ + getIsExperimentalFeatureEnabled: jest.fn(), +})); + +import { getIsExperimentalFeatureEnabled } from '../../../../common/get_experimental_features'; + const fakeNow = new Date('2020-02-09T23:15:41.941Z'); const fake2MinutesAgo = new Date('2020-02-09T23:13:41.941Z'); @@ -29,12 +36,16 @@ const mockAPIs = { }; beforeAll(() => { - jest.resetAllMocks(); + jest.clearAllMocks(); global.Date.now = jest.fn(() => fakeNow.getTime()); }); +beforeEach(() => { + (getIsExperimentalFeatureEnabled as jest.Mock).mockImplementation(() => false); +}); + describe('rules', () => { - it('render a list of rules', () => { + it('render a list of rules', async () => { const rule = mockRule(); const ruleType = mockRuleType(); const ruleSummary = mockRuleSummary({ @@ -59,19 +70,22 @@ describe('rules', () => { alertToListItem(fakeNow.getTime(), ruleType, 'first_rule', ruleSummary.alerts.first_rule), ]; - expect( - shallow( - - ) - .find(EuiBasicTable) - .prop('items') - ).toEqual(rules); + const wrapper = mountWithIntl( + + ); + + await act(async () => { + await new Promise((resolve) => setTimeout(resolve)); + wrapper.update(); + }); + + expect(wrapper.find(RuleAlertList).prop('items')).toEqual(rules); }); it('render a hidden field with duration epoch', () => { @@ -95,7 +109,7 @@ describe('rules', () => { ).toEqual(fake2MinutesAgo.getTime()); }); - it('render all active rules', () => { + it('render all active rules', async () => { const rule = mockRule(); const ruleType = mockRuleType(); const alerts: Record = { @@ -108,27 +122,31 @@ describe('rules', () => { muted: false, }, }; - expect( - shallow( - - ) - .find(EuiBasicTable) - .prop('items') - ).toEqual([ + + const wrapper = mountWithIntl( + + ); + + await act(async () => { + await new Promise((resolve) => setTimeout(resolve)); + wrapper.update(); + }); + + expect(wrapper.find(RuleAlertList).prop('items')).toEqual([ alertToListItem(fakeNow.getTime(), ruleType, 'us-central', alerts['us-central']), alertToListItem(fakeNow.getTime(), ruleType, 'us-east', alerts['us-east']), ]); }); - it('render all inactive rules', () => { + it('render all inactive rules', async () => { const rule = mockRule({ mutedInstanceIds: ['us-west', 'us-east'], }); @@ -136,30 +154,33 @@ describe('rules', () => { const ruleUsWest: AlertStatus = { status: 'OK', muted: false }; const ruleUsEast: AlertStatus = { status: 'OK', muted: false }; - expect( - shallow( - - ) - .find(EuiBasicTable) - .prop('items') - ).toEqual([ + 'us-east': { + status: 'OK', + muted: false, + }, + }, + })} + /> + ); + + await act(async () => { + await new Promise((resolve) => setTimeout(resolve)); + wrapper.update(); + }); + + expect(wrapper.find(RuleAlertList).prop('items')).toEqual([ alertToListItem(fakeNow.getTime(), ruleType, 'us-west', ruleUsWest), alertToListItem(fakeNow.getTime(), ruleType, 'us-east', ruleUsEast), ]); @@ -379,6 +400,64 @@ describe('execution duration overview', () => { }); }); +describe('tabbed content', () => { + it('tabbed content renders when the event log experiment is on', async () => { + // Enable the event log experiment + (getIsExperimentalFeatureEnabled as jest.Mock).mockImplementation(() => true); + + const rule = mockRule(); + const ruleType = mockRuleType(); + const ruleSummary = mockRuleSummary({ + alerts: { + first_rule: { + status: 'OK', + muted: false, + actionGroupId: 'default', + }, + second_rule: { + status: 'Active', + muted: false, + actionGroupId: 'action group id unknown', + }, + }, + }); + + const wrapper = shallow( + + ); + + const tabbedContent = wrapper.find('[data-test-subj="ruleDetailsTabbedContent"]').dive(); + + // Need to mock this function + (tabbedContent.instance() as any).focusTab = jest.fn(); + tabbedContent.update(); + + await act(async () => { + await new Promise((resolve) => setTimeout(resolve)); + tabbedContent.update(); + }); + + expect(tabbedContent.find('[aria-labelledby="rule_event_log_list"]').exists()).toBeTruthy(); + expect(tabbedContent.find('[aria-labelledby="rule_alert_list"]').exists()).toBeFalsy(); + + tabbedContent.find('[data-test-subj="ruleAlertListTab"]').simulate('click'); + + expect(tabbedContent.find('[aria-labelledby="rule_event_log_list"]').exists()).toBeFalsy(); + expect(tabbedContent.find('[aria-labelledby="rule_alert_list"]').exists()).toBeTruthy(); + + tabbedContent.find('[data-test-subj="eventLogListTab"]').simulate('click'); + + expect(tabbedContent.find('[aria-labelledby="rule_event_log_list"]').exists()).toBeTruthy(); + expect(tabbedContent.find('[aria-labelledby="rule_alert_list"]').exists()).toBeFalsy(); + }); +}); + function mockRule(overloads: Partial = {}): Rule { return { id: uuid.v4(), diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.tsx index 1a08f12c117435..c3eb699cc0c90b 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.tsx @@ -5,37 +5,32 @@ * 2.0. */ -import React, { useState } from 'react'; -import moment, { Duration } from 'moment'; +import React, { lazy } from 'react'; import { i18n } from '@kbn/i18n'; import { - EuiBasicTable, EuiHealth, EuiSpacer, - EuiToolTip, EuiFlexGroup, EuiFlexItem, EuiHorizontalRule, EuiPanel, EuiStat, EuiIconTip, + EuiTabbedContent, } from '@elastic/eui'; // @ts-ignore import { RIGHT_ALIGNMENT, CENTER_ALIGNMENT } from '@elastic/eui/lib/services'; -import { padStart, chunk } from 'lodash'; import { ActionGroup, AlertExecutionStatusErrorReasons, AlertStatusValues, } from '../../../../../../alerting/common'; -import { Rule, RuleSummary, AlertStatus, RuleType, Pagination } from '../../../../types'; +import { Rule, RuleSummary, AlertStatus, RuleType } from '../../../../types'; import { ComponentOpts as RuleApis, withBulkRuleOperations, } from '../../common/components/with_bulk_rule_api_operations'; -import { DEFAULT_SEARCH_PAGE_SIZE } from '../../../constants'; import './rule.scss'; -import { AlertMutedSwitch } from './alert_muted_switch'; import { getHealthColor } from '../../rules_list/components/rule_status_filter'; import { rulesStatusesTranslationsMapping, @@ -46,6 +41,14 @@ import { shouldShowDurationWarning, } from '../../../lib/execution_duration_utils'; import { ExecutionDurationChart } from '../../common/components/execution_duration_chart'; +// import { RuleEventLogListWithApi } from './rule_event_log_list'; +import { AlertListItem } from './types'; +import { getIsExperimentalFeatureEnabled } from '../../../../common/get_experimental_features'; +import { suspendedComponentWithProps } from '../../../lib/suspended_component_with_props'; + +const RuleEventLogListWithApi = lazy(() => import('./rule_event_log_list')); + +const RuleAlertList = lazy(() => import('./rule_alert_list')); type RuleProps = { rule: Rule; @@ -59,95 +62,8 @@ type RuleProps = { isLoadingChart?: boolean; } & Pick; -export const alertsTableColumns = ( - onMuteAction: (alert: AlertListItem) => Promise, - readOnly: boolean -) => [ - { - field: 'alert', - name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.Alert', { - defaultMessage: 'Alert', - }), - sortable: false, - truncateText: true, - width: '45%', - 'data-test-subj': 'alertsTableCell-alert', - render: (value: string) => { - return ( - - {value} - - ); - }, - }, - { - field: 'status', - name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.status', { - defaultMessage: 'Status', - }), - width: '15%', - render: (value: AlertListItemStatus) => { - return ( - - {value.label} - {value.actionGroup ? ` (${value.actionGroup})` : ``} - - ); - }, - sortable: false, - 'data-test-subj': 'alertsTableCell-status', - }, - { - field: 'start', - width: '190px', - render: (value: Date | undefined) => { - return value ? moment(value).format('D MMM YYYY @ HH:mm:ss') : ''; - }, - name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.start', { - defaultMessage: 'Start', - }), - sortable: false, - 'data-test-subj': 'alertsTableCell-start', - }, - { - field: 'duration', - render: (value: number) => { - return value ? durationAsString(moment.duration(value)) : ''; - }, - name: i18n.translate( - 'xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.duration', - { defaultMessage: 'Duration' } - ), - sortable: false, - width: '80px', - 'data-test-subj': 'alertsTableCell-duration', - }, - { - field: '', - align: RIGHT_ALIGNMENT, - width: '60px', - name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.mute', { - defaultMessage: 'Mute', - }), - render: (alert: AlertListItem) => { - return ( - await onMuteAction(alert)} - alert={alert} - /> - ); - }, - sortable: false, - 'data-test-subj': 'alertsTableCell-actions', - }, -]; - -function durationAsString(duration: Duration): string { - return [duration.hours(), duration.minutes(), duration.seconds()] - .map((value) => padStart(`${value}`, 2, '0')) - .join(':'); -} +const EVENT_LOG_LIST_TAB = 'rule_event_log_list'; +const ALERT_LIST_TAB = 'rule_alert_list'; export function RuleComponent({ rule, @@ -162,17 +78,10 @@ export function RuleComponent({ durationEpoch = Date.now(), isLoadingChart, }: RuleProps) { - const [pagination, setPagination] = useState({ - index: 0, - size: DEFAULT_SEARCH_PAGE_SIZE, - }); - const alerts = Object.entries(ruleSummary.alerts) .map(([alertId, alert]) => alertToListItem(durationEpoch, ruleType, alertId, alert)) .sort((leftAlert, rightAlert) => leftAlert.sortPriority - rightAlert.sortPriority); - const pageOfAlerts = getPage(alerts, pagination); - const onMuteAction = async (alert: AlertListItem) => { await (alert.isMuted ? unmuteAlertInstance(rule, alert.alert) @@ -192,6 +101,44 @@ export function RuleComponent({ ? ALERT_STATUS_LICENSE_ERROR : rulesStatusesTranslationsMapping[rule.executionStatus.status]; + const renderRuleAlertList = () => { + return suspendedComponentWithProps( + RuleAlertList, + 'xl' + )({ + items: alerts, + readOnly, + onMuteAction, + }); + }; + + const tabs = [ + { + id: EVENT_LOG_LIST_TAB, + name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.rule.eventLogTabText', { + defaultMessage: 'Execution History', + }), + 'data-test-subj': 'eventLogListTab', + content: suspendedComponentWithProps(RuleEventLogListWithApi, 'xl')({ rule }), + }, + { + id: ALERT_LIST_TAB, + name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.rule.alertsTabText', { + defaultMessage: 'Alerts', + }), + 'data-test-subj': 'ruleAlertListTab', + content: renderRuleAlertList(), + }, + ]; + + const renderTabs = () => { + const isEnabled = getIsExperimentalFeatureEnabled('rulesDetailLogs'); + if (isEnabled) { + return ; + } + return renderRuleAlertList(); + }; + return ( <> @@ -277,50 +224,12 @@ export function RuleComponent({ name="alertsDurationEpoch" value={durationEpoch} /> - { - setPagination(changedPage); - }} - rowProps={() => ({ - 'data-test-subj': 'alert-row', - })} - cellProps={() => ({ - 'data-test-subj': 'cell', - })} - columns={alertsTableColumns(onMuteAction, readOnly)} - data-test-subj="alertsList" - tableLayout="fixed" - className="alertsList" - /> + {renderTabs()} ); } export const RuleWithApi = withBulkRuleOperations(RuleComponent); -function getPage(items: any[], pagination: Pagination) { - return chunk(items, pagination.size)[pagination.index] || []; -} - -interface AlertListItemStatus { - label: string; - healthColor: string; - actionGroup?: string; -} -export interface AlertListItem { - alert: string; - status: AlertListItemStatus; - start?: Date; - duration: number; - isMuted: boolean; - sortPriority: number; -} - const ACTIVE_LABEL = i18n.translate( 'xpack.triggersActionsUI.sections.ruleDetails.rulesList.status.active', { defaultMessage: 'Active' } diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_alert_list.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_alert_list.tsx new file mode 100644 index 00000000000000..5756edd360393d --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_alert_list.tsx @@ -0,0 +1,168 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useMemo, useCallback, useState } from 'react'; +import moment, { Duration } from 'moment'; +import { padStart, chunk } from 'lodash'; +import { EuiHealth, EuiBasicTable, EuiToolTip } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; +import { RIGHT_ALIGNMENT } from '@elastic/eui/lib/services'; +import { DEFAULT_SEARCH_PAGE_SIZE } from '../../../constants'; +import { Pagination } from '../../../../types'; +import { AlertListItemStatus, AlertListItem } from './types'; +import { AlertMutedSwitch } from './alert_muted_switch'; + +const durationAsString = (duration: Duration): string => { + return [duration.hours(), duration.minutes(), duration.seconds()] + .map((value) => padStart(`${value}`, 2, '0')) + .join(':'); +}; + +const alertsTableColumns = ( + onMuteAction: (alert: AlertListItem) => Promise, + readOnly: boolean +) => [ + { + field: 'alert', + name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.Alert', { + defaultMessage: 'Alert', + }), + sortable: false, + truncateText: true, + width: '45%', + 'data-test-subj': 'alertsTableCell-alert', + render: (value: string) => { + return ( + + {value} + + ); + }, + }, + { + field: 'status', + name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.status', { + defaultMessage: 'Status', + }), + width: '15%', + render: (value: AlertListItemStatus) => { + return ( + + {value.label} + {value.actionGroup ? ` (${value.actionGroup})` : ``} + + ); + }, + sortable: false, + 'data-test-subj': 'alertsTableCell-status', + }, + { + field: 'start', + width: '190px', + render: (value: Date | undefined) => { + return value ? moment(value).format('D MMM YYYY @ HH:mm:ss') : ''; + }, + name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.start', { + defaultMessage: 'Start', + }), + sortable: false, + 'data-test-subj': 'alertsTableCell-start', + }, + { + field: 'duration', + render: (value: number) => { + return value ? durationAsString(moment.duration(value)) : ''; + }, + name: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.duration', + { defaultMessage: 'Duration' } + ), + sortable: false, + width: '80px', + 'data-test-subj': 'alertsTableCell-duration', + }, + { + field: '', + align: RIGHT_ALIGNMENT, + width: '60px', + name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.alertsList.columns.mute', { + defaultMessage: 'Mute', + }), + render: (alert: AlertListItem) => { + return ( + await onMuteAction(alert)} + alert={alert} + /> + ); + }, + sortable: false, + 'data-test-subj': 'alertsTableCell-actions', + }, +]; + +interface RuleAlertListProps { + items: AlertListItem[]; + readOnly: boolean; + onMuteAction: (alert: AlertListItem) => Promise; +} + +const getRowProps = () => ({ + 'data-test-subj': 'alert-row', +}); + +const getCellProps = () => ({ + 'data-test-subj': 'cell', +}); + +function getPage(items: T[], pagination: Pagination) { + return chunk(items, pagination.size)[pagination.index] || []; +} + +export const RuleAlertList = (props: RuleAlertListProps) => { + const { items, readOnly, onMuteAction } = props; + + const [pagination, setPagination] = useState({ + index: 0, + size: DEFAULT_SEARCH_PAGE_SIZE, + }); + + const pageOfAlerts = getPage(items, pagination); + + const paginationOptions = useMemo(() => { + return { + pageIndex: pagination.index, + pageSize: pagination.size, + totalItemCount: items.length, + }; + }, [pagination, items]); + + const onChange = useCallback( + ({ page: changedPage }: { page: Pagination }) => { + setPagination(changedPage); + }, + [setPagination] + ); + + return ( + + items={pageOfAlerts} + pagination={paginationOptions} + onChange={onChange} + rowProps={getRowProps} + cellProps={getCellProps} + columns={alertsTableColumns(onMuteAction, readOnly)} + data-test-subj="alertsList" + tableLayout="fixed" + className="alertsList" + /> + ); +}; + +// eslint-disable-next-line import/no-default-export +export { RuleAlertList as default }; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.test.tsx new file mode 100644 index 00000000000000..008e19bcb99bf2 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.test.tsx @@ -0,0 +1,504 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import uuid from 'uuid'; +import { act } from 'react-dom/test-utils'; +import { mountWithIntl, nextTick } from '@kbn/test-jest-helpers'; +import { useKibana } from '../../../../common/lib/kibana'; + +import { EuiSuperDatePicker, EuiDataGrid } from '@elastic/eui'; +import { RuleEventLogListStatusFilter } from './rule_event_log_list_status_filter'; +import { RuleEventLogList } from './rule_event_log_list'; +import { RULE_EXECUTION_DEFAULT_INITIAL_VISIBLE_COLUMNS } from '../../../constants'; +import { Rule } from '../../../../types'; + +const useKibanaMock = useKibana as jest.Mocked; +jest.mock('../../../../common/lib/kibana'); + +const mockLogResponse: any = { + data: [ + { + id: uuid.v4(), + timestamp: '2022-03-20T07:40:44-07:00', + duration: 5000000, + status: 'success', + message: 'rule execution #1', + num_active_alerts: 2, + num_new_alerts: 4, + num_recovered_alerts: 3, + num_triggered_actions: 10, + num_succeeded_actions: 0, + num_errored_actions: 4, + total_search_duration: 1000000, + es_search_duration: 1400000, + schedule_delay: 2000000, + timed_out: false, + }, + { + id: uuid.v4(), + timestamp: '2022-03-20T07:40:45-07:00', + duration: 6000000, + status: 'success', + message: 'rule execution #2', + num_active_alerts: 4, + num_new_alerts: 2, + num_recovered_alerts: 4, + num_triggered_actions: 5, + num_succeeded_actions: 3, + num_errored_actions: 0, + total_search_duration: 300000, + es_search_duration: 300000, + schedule_delay: 300000, + timed_out: false, + }, + { + id: uuid.v4(), + timestamp: '2022-03-20T07:40:46-07:00', + duration: 340000, + status: 'failure', + message: 'rule execution #3', + num_active_alerts: 8, + num_new_alerts: 5, + num_recovered_alerts: 0, + num_triggered_actions: 1, + num_succeeded_actions: 1, + num_errored_actions: 4, + total_search_duration: 2300000, + es_search_duration: 2300000, + schedule_delay: 2300000, + timed_out: false, + }, + { + id: uuid.v4(), + timestamp: '2022-03-21T07:40:46-07:00', + duration: 3000000, + status: 'unknown', + message: 'rule execution #4', + num_active_alerts: 4, + num_new_alerts: 4, + num_recovered_alerts: 4, + num_triggered_actions: 4, + num_succeeded_actions: 4, + num_errored_actions: 4, + total_search_duration: 400000, + es_search_duration: 400000, + schedule_delay: 400000, + timed_out: false, + }, + ], + total: 4, +}; + +const mockRule: Rule = { + id: uuid.v4(), + enabled: true, + name: `rule-${uuid.v4()}`, + tags: [], + ruleTypeId: '.noop', + consumer: 'consumer', + schedule: { interval: '1m' }, + actions: [], + params: {}, + createdBy: null, + updatedBy: null, + createdAt: new Date(), + updatedAt: new Date(), + apiKeyOwner: null, + throttle: null, + notifyWhen: null, + muteAll: false, + mutedInstanceIds: [], + executionStatus: { + status: 'unknown', + lastExecutionDate: new Date('2020-08-20T19:23:38Z'), + }, +}; + +const loadExecutionLogAggregationsMock = jest.fn(); + +describe('rule_event_log_list', () => { + beforeEach(() => { + jest.clearAllMocks(); + useKibanaMock().services.uiSettings.get = jest.fn().mockImplementation((value: string) => { + if (value === 'timepicker:quickRanges') { + return [ + { + from: 'now-15m', + to: 'now', + display: 'Last 15 minutes', + }, + ]; + } + }); + loadExecutionLogAggregationsMock.mockResolvedValue(mockLogResponse); + }); + + it('renders correctly', async () => { + const wrapper = mountWithIntl( + + ); + + // Run the initial load fetch call + expect(loadExecutionLogAggregationsMock).toHaveBeenCalledTimes(1); + + expect(loadExecutionLogAggregationsMock).toHaveBeenCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [], + filter: [], + page: 0, + perPage: 10, + }) + ); + + // Loading + expect(wrapper.find(EuiSuperDatePicker).props().isLoading).toBeTruthy(); + + // Verify the initial columns are rendered + RULE_EXECUTION_DEFAULT_INITIAL_VISIBLE_COLUMNS.forEach((column) => { + expect(wrapper.find(`[data-test-subj="dataGridHeaderCell-${column}"]`).exists()).toBeTruthy(); + }); + + // No data initially + expect(wrapper.find('[data-gridcell-column-id="timestamp"]').length).toEqual(1); + + // Let the load resolve + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(wrapper.find(EuiSuperDatePicker).props().isLoading).toBeFalsy(); + + expect(wrapper.find(RuleEventLogListStatusFilter).exists()).toBeTruthy(); + expect(wrapper.find('[data-gridcell-column-id="timestamp"]').length).toEqual(5); + expect(wrapper.find(EuiDataGrid).props().rowCount).toEqual(mockLogResponse.total); + }); + + it('can sort by single and/or multiple column(s)', async () => { + const wrapper = mountWithIntl( + + ); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + let headerCellButton = wrapper.find('[data-test-subj="dataGridHeaderCell-timestamp"] button'); + + headerCellButton.simulate('click'); + + let headerAction = wrapper.find('[data-test-subj="dataGridHeaderCellActionGroup-timestamp"]'); + + expect(headerAction.exists()).toBeTruthy(); + + // Sort by the timestamp column + headerAction.find('li').at(1).find('button').simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [ + { + timestamp: { + order: 'asc', + }, + }, + ], + filter: [], + page: 0, + perPage: 10, + }) + ); + + // Open the popover again + headerCellButton.simulate('click'); + + headerAction = wrapper.find('[data-test-subj="dataGridHeaderCellActionGroup-timestamp"]'); + + // Sort by the timestamp column, this time, in the opposite direction + headerAction.find('li').at(2).find('button').simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [ + { + timestamp: { + order: 'desc', + }, + }, + ], + filter: [], + page: 0, + perPage: 10, + }) + ); + + // Find another column + headerCellButton = wrapper.find( + '[data-test-subj="dataGridHeaderCell-execution_duration"] button' + ); + + // Open the popover again + headerCellButton.simulate('click'); + + headerAction = wrapper.find( + '[data-test-subj="dataGridHeaderCellActionGroup-execution_duration"]' + ); + + // Sort + headerAction.find('li').at(1).find('button').simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [ + { + timestamp: { order: 'desc' }, + }, + { + execution_duration: { order: 'asc' }, + }, + ], + filter: [], + page: 0, + perPage: 10, + }) + ); + }); + + it('can filter by execution log outcome status', async () => { + const wrapper = mountWithIntl( + + ); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + // Filter by success + wrapper.find('[data-test-subj="ruleEventLogStatusFilterButton"]').at(0).simulate('click'); + + wrapper.find('[data-test-subj="ruleEventLogStatusFilter-success"]').at(0).simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [], + filter: ['success'], + page: 0, + perPage: 10, + }) + ); + + // Filter by failure as well + wrapper.find('[data-test-subj="ruleEventLogStatusFilterButton"]').at(0).simulate('click'); + + wrapper.find('[data-test-subj="ruleEventLogStatusFilter-failure"]').at(0).simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [], + filter: ['success', 'failure'], + page: 0, + perPage: 10, + }) + ); + }); + + it('can paginate', async () => { + loadExecutionLogAggregationsMock.mockResolvedValue({ + ...mockLogResponse, + total: 100, + }); + + const wrapper = mountWithIntl( + + ); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(wrapper.find('.euiPagination').exists()).toBeTruthy(); + + // Paginate to the next page + wrapper.find('.euiPagination .euiPagination__item a').at(0).simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [], + filter: [], + page: 1, + perPage: 10, + }) + ); + + // Change the page size + wrapper.find('[data-test-subj="tablePaginationPopoverButton"] button').simulate('click'); + + wrapper.find('[data-test-subj="tablePagination-50-rows"] button').simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [], + filter: [], + page: 0, + perPage: 50, + }) + ); + }); + + it('can filter by start and end date', async () => { + const nowMock = jest.spyOn(Date, 'now').mockReturnValue(0); + + const wrapper = mountWithIntl( + + ); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [], + filter: [], + page: 0, + perPage: 10, + dateStart: '1969-12-30T19:00:00-05:00', + dateEnd: '1969-12-31T19:00:00-05:00', + }) + ); + + wrapper + .find('[data-test-subj="superDatePickerToggleQuickMenuButton"] button') + .simulate('click'); + + wrapper + .find('[data-test-subj="superDatePickerCommonlyUsed_Last_15 minutes"] button') + .simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect(loadExecutionLogAggregationsMock).toHaveBeenLastCalledWith( + expect.objectContaining({ + id: mockRule.id, + sort: [], + filter: [], + page: 0, + perPage: 10, + dateStart: '1969-12-31T18:45:00-05:00', + dateEnd: '1969-12-31T19:00:00-05:00', + }) + ); + + nowMock.mockRestore(); + }); + + it('can save display columns to localStorage', async () => { + const wrapper = mountWithIntl( + + ); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect( + JSON.parse( + localStorage.getItem('xpack.triggersActionsUI.ruleEventLogList.initialColumns') ?? 'null' + ) + ).toEqual(RULE_EXECUTION_DEFAULT_INITIAL_VISIBLE_COLUMNS); + + wrapper.find('[data-test-subj="dataGridColumnSelectorButton"] button').simulate('click'); + + wrapper + .find( + '[data-test-subj="dataGridColumnSelectorToggleColumnVisibility-num_active_alerts"] button' + ) + .simulate('click'); + + await act(async () => { + await nextTick(); + wrapper.update(); + }); + + expect( + JSON.parse( + localStorage.getItem('xpack.triggersActionsUI.ruleEventLogList.initialColumns') ?? 'null' + ) + ).toEqual([...RULE_EXECUTION_DEFAULT_INITIAL_VISIBLE_COLUMNS, 'num_active_alerts']); + }); +}); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.tsx new file mode 100644 index 00000000000000..9a6814d1dd9c4e --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.tsx @@ -0,0 +1,446 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useCallback, useEffect, useState, useMemo } from 'react'; +import { i18n } from '@kbn/i18n'; +import datemath from '@elastic/datemath'; +import { + EuiDataGrid, + EuiFlexItem, + EuiFlexGroup, + EuiProgress, + EuiSpacer, + EuiDataGridSorting, + Pagination, + EuiSuperDatePicker, + EuiDataGridCellValueElementProps, + OnTimeChangeProps, +} from '@elastic/eui'; +import { useKibana } from '../../../../common/lib/kibana'; +import { RULE_EXECUTION_DEFAULT_INITIAL_VISIBLE_COLUMNS } from '../../../constants'; +import { RuleEventLogListStatusFilter } from './rule_event_log_list_status_filter'; +import { RuleEventLogListCellRenderer, ColumnId } from './rule_event_log_list_cell_renderer'; + +import { LoadExecutionLogAggregationsProps } from '../../../lib/rule_api'; +import { Rule } from '../../../../types'; +import { + IExecutionLog, + executionLogSortableColumns, + ExecutionLogSortFields, +} from '../../../../../../alerting/common'; +import { + ComponentOpts as RuleApis, + withBulkRuleOperations, +} from '../../common/components/with_bulk_rule_api_operations'; + +const getParsedDate = (date: string) => { + if (date.includes('now')) { + return datemath.parse(date)?.format() || date; + } + return date; +}; + +const getIsColumnSortable = (columnId: string) => { + return executionLogSortableColumns.includes(columnId as ExecutionLogSortFields); +}; + +const columns = [ + { + id: 'id', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.id', + { + defaultMessage: 'Id', + } + ), + isSortable: getIsColumnSortable('id'), + }, + { + id: 'timestamp', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.timestamp', + { + defaultMessage: 'Timestamp', + } + ), + isSortable: getIsColumnSortable('timestamp'), + initialWidth: 250, + }, + { + id: 'execution_duration', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.duration', + { + defaultMessage: 'Duration', + } + ), + isSortable: getIsColumnSortable('execution_duration'), + initialWidth: 100, + }, + { + id: 'status', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.status', + { + defaultMessage: 'Status', + } + ), + isSortable: getIsColumnSortable('status'), + initialWidth: 100, + }, + { + id: 'message', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.message', + { + defaultMessage: 'Message', + } + ), + isSortable: getIsColumnSortable('message'), + }, + { + id: 'num_active_alerts', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.activeAlerts', + { + defaultMessage: 'Active alerts', + } + ), + isSortable: getIsColumnSortable('num_active_alerts'), + }, + { + id: 'num_new_alerts', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.newAlerts', + { + defaultMessage: 'New alerts', + } + ), + isSortable: getIsColumnSortable('num_new_alerts'), + }, + { + id: 'num_recovered_alerts', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.recoveredAlerts', + { + defaultMessage: 'Recovered alerts', + } + ), + isSortable: getIsColumnSortable('num_recovered_alerts'), + }, + { + id: 'num_triggered_actions', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.triggeredActions', + { + defaultMessage: 'Triggered actions', + } + ), + isSortable: getIsColumnSortable('num_triggered_actions'), + }, + { + id: 'num_succeeded_actions', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.succeededActions', + { + defaultMessage: 'Succeeded actions', + } + ), + isSortable: getIsColumnSortable('num_succeeded_actions'), + }, + { + id: 'num_errored_actions', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.erroredActions', + { + defaultMessage: 'Errored actions', + } + ), + isSortable: getIsColumnSortable('num_errored_actions'), + }, + { + id: 'total_search_duration', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.totalSearchDuration', + { + defaultMessage: 'Total search duration', + } + ), + isSortable: getIsColumnSortable('total_search_duration'), + }, + { + id: 'es_search_duration', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.esSearchDuration', + { + defaultMessage: 'ES search duration', + } + ), + isSortable: getIsColumnSortable('es_search_duration'), + }, + { + id: 'schedule_delay', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.scheduleDelay', + { + defaultMessage: 'Schedule delay', + } + ), + isSortable: getIsColumnSortable('schedule_delay'), + }, + { + id: 'timed_out', + displayAsText: i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.timedOut', + { + defaultMessage: 'Timed out', + } + ), + isSortable: getIsColumnSortable('timed_out'), + }, +]; + +const API_FAILED_MESSAGE = i18n.translate( + 'xpack.triggersActionsUI.sections.ruleDetails.eventLogColumn.apiError', + { + defaultMessage: 'Failed to fetch execution history', + } +); + +const RULE_EVENT_LOG_LIST_STORAGE_KEY = 'xpack.triggersActionsUI.ruleEventLogList.initialColumns'; + +const PAGE_SIZE_OPTION = [10, 50, 100]; + +const updateButtonProps = { + iconOnly: true, + fill: false, +}; + +export type RuleEventLogListProps = { + rule: Rule; + localStorageKey?: string; +} & Pick; + +export const RuleEventLogList = (props: RuleEventLogListProps) => { + const { + rule, + localStorageKey = RULE_EVENT_LOG_LIST_STORAGE_KEY, + loadExecutionLogAggregations, + } = props; + + const { uiSettings, notifications } = useKibana().services; + + // Data grid states + const [logs, setLogs] = useState([]); + const [visibleColumns, setVisibleColumns] = useState(() => { + return ( + JSON.parse(localStorage.getItem(localStorageKey) ?? 'null') || + RULE_EXECUTION_DEFAULT_INITIAL_VISIBLE_COLUMNS + ); + }); + const [sortingColumns, setSortingColumns] = useState([]); + const [filter, setFilter] = useState([]); + const [pagination, setPagination] = useState({ + pageIndex: 0, + pageSize: 10, + totalItemCount: 0, + }); + + // Date related states + const [isLoading, setIsLoading] = useState(false); + const [dateStart, setDateStart] = useState('now-24h'); + const [dateEnd, setDateEnd] = useState('now'); + const [dateFormat] = useState(() => uiSettings?.get('dateFormat')); + const [commonlyUsedRanges] = useState(() => { + return ( + uiSettings + ?.get('timepicker:quickRanges') + ?.map(({ from, to, display }: { from: string; to: string; display: string }) => ({ + start: from, + end: to, + label: display, + })) || [] + ); + }); + + // Main cell renderer, renders durations, statuses, etc. + const renderCell = ({ rowIndex, columnId }: EuiDataGridCellValueElementProps) => { + const { pageIndex, pageSize } = pagination; + const pagedRowIndex = rowIndex - pageIndex * pageSize; + + const value = logs?.[pagedRowIndex]?.[columnId as keyof IExecutionLog] as string; + return ( + + ); + }; + + // Computed data grid props + const sortingProps = useMemo( + () => ({ + onSort: setSortingColumns, + columns: sortingColumns, + }), + [sortingColumns] + ); + + // Formats the sort columns to be consumed by the API endpoint + const formattedSort = useMemo(() => { + return sortingColumns.map(({ id: sortId, direction }) => ({ + [sortId]: { + order: direction, + }, + })); + }, [sortingColumns]); + + const loadEventLogs = async () => { + setIsLoading(true); + try { + const result = await loadExecutionLogAggregations({ + id: rule.id, + sort: formattedSort as LoadExecutionLogAggregationsProps['sort'], + filter, + dateStart: getParsedDate(dateStart), + dateEnd: getParsedDate(dateEnd), + page: pagination.pageIndex, + perPage: pagination.pageSize, + }); + setLogs(result.data); + setPagination({ + ...pagination, + totalItemCount: result.total, + }); + } catch (e) { + notifications.toasts.addDanger({ + title: API_FAILED_MESSAGE, + text: e.body.message, + }); + } + setIsLoading(false); + }; + + const onChangeItemsPerPage = useCallback( + (pageSize: number) => { + setPagination((prevPagination) => ({ + ...prevPagination, + pageIndex: 0, + pageSize, + })); + }, + [setPagination] + ); + + const onChangePage = useCallback( + (pageIndex: number) => { + setPagination((prevPagination) => ({ + ...prevPagination, + pageIndex, + })); + }, + [setPagination] + ); + + const paginationProps = useMemo( + () => ({ + ...pagination, + pageSizeOptions: PAGE_SIZE_OPTION, + onChangeItemsPerPage, + onChangePage, + }), + [pagination, onChangeItemsPerPage, onChangePage] + ); + + const columnVisibilityProps = useMemo( + () => ({ + visibleColumns, + setVisibleColumns, + }), + [visibleColumns, setVisibleColumns] + ); + + const onTimeChange = useCallback( + ({ start, end, isInvalid }: OnTimeChangeProps) => { + if (isInvalid) { + return; + } + setDateStart(start); + setDateEnd(end); + }, + [setDateStart, setDateEnd] + ); + + const onRefresh = () => { + loadEventLogs(); + }; + + const onFilterChange = useCallback( + (newFilter: string[]) => { + setPagination((prevPagination) => ({ + ...prevPagination, + pageIndex: 0, + })); + setFilter(newFilter); + }, + [setPagination, setFilter] + ); + + useEffect(() => { + loadEventLogs(); + // eslint-disable-next-line react-hooks/exhaustive-deps + }, [sortingColumns, dateStart, dateEnd, filter, pagination.pageIndex, pagination.pageSize]); + + useEffect(() => { + localStorage.setItem(localStorageKey, JSON.stringify(visibleColumns)); + }, [localStorageKey, visibleColumns]); + + return ( +
+ + + + + + + + + + + {isLoading && ( + + )} + +
+ ); +}; + +export const RuleEventLogListWithApi = withBulkRuleOperations(RuleEventLogList); + +// eslint-disable-next-line import/no-default-export +export { RuleEventLogListWithApi as default }; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_cell_renderer.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_cell_renderer.test.tsx new file mode 100644 index 00000000000000..f973815dbd586b --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_cell_renderer.test.tsx @@ -0,0 +1,62 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import moment from 'moment'; +import { EuiIcon } from '@elastic/eui'; +import { shallow, mount } from 'enzyme'; +import { + RuleEventLogListCellRenderer, + DEFAULT_DATE_FORMAT, +} from './rule_event_log_list_cell_renderer'; +import { RuleEventLogListStatus } from './rule_event_log_list_status'; +import { RuleDurationFormat } from '../../../sections/rules_list/components/rule_duration_format'; + +describe('rule_event_log_list_cell_renderer', () => { + it('renders primitive values correctly', () => { + const wrapper = shallow(); + + expect(wrapper.text()).toEqual('test'); + }); + + it('renders undefined correctly', () => { + const wrapper = shallow(); + + expect(wrapper.text()).toBeFalsy(); + }); + + it('renders date duration correctly', () => { + const wrapper = shallow( + + ); + + expect(wrapper.find(RuleDurationFormat).exists()).toBeTruthy(); + expect(wrapper.find(RuleDurationFormat).props().duration).toEqual(100000); + }); + + it('renders timestamps correctly', () => { + const time = '2022-03-20T07:40:44-07:00'; + const wrapper = shallow(); + + expect(wrapper.text()).toEqual(moment(time).format(DEFAULT_DATE_FORMAT)); + }); + + it('renders alert status correctly', () => { + const wrapper = shallow(); + + expect(wrapper.find(RuleEventLogListStatus).exists()).toBeTruthy(); + expect(wrapper.find(RuleEventLogListStatus).props().status).toEqual('success'); + }); + + it('unaccounted status will still render, but with the unknown color', () => { + const wrapper = mount(); + + expect(wrapper.find(RuleEventLogListStatus).exists()).toBeTruthy(); + expect(wrapper.find(RuleEventLogListStatus).text()).toEqual('newOutcome'); + expect(wrapper.find(EuiIcon).props().color).toEqual('gray'); + }); +}); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_cell_renderer.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_cell_renderer.tsx new file mode 100644 index 00000000000000..ea502f6c5ebbcc --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_cell_renderer.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import moment from 'moment'; +import { EcsEventOutcome } from 'kibana/server'; +import { RuleEventLogListStatus } from './rule_event_log_list_status'; +import { RuleDurationFormat } from '../../../sections/rules_list/components/rule_duration_format'; +import { + RULE_EXECUTION_LOG_COLUMN_IDS, + RULE_EXECUTION_LOG_DURATION_COLUMNS, +} from '../../../constants'; + +export const DEFAULT_DATE_FORMAT = 'MMM D, YYYY @ HH:mm:ss.SSS'; + +export type ColumnId = typeof RULE_EXECUTION_LOG_COLUMN_IDS[number]; + +interface RuleEventLogListCellRendererProps { + columnId: ColumnId; + value?: string; + dateFormat?: string; +} + +export const RuleEventLogListCellRenderer = (props: RuleEventLogListCellRendererProps) => { + const { columnId, value, dateFormat = DEFAULT_DATE_FORMAT } = props; + + if (typeof value === 'undefined') { + return null; + } + + if (columnId === 'status') { + return ; + } + + if (columnId === 'timestamp') { + return <>{moment(value).format(dateFormat)}; + } + + if (RULE_EXECUTION_LOG_DURATION_COLUMNS.includes(columnId)) { + return ; + } + + return <>{value}; +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status.tsx new file mode 100644 index 00000000000000..8b50ec1469698a --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status.tsx @@ -0,0 +1,42 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { EuiIcon } from '@elastic/eui'; +import { EcsEventOutcome } from 'kibana/server'; + +interface RuleEventLogListStatusProps { + status: EcsEventOutcome; +} + +const statusContainerStyles = { + display: 'flex', + alignItems: 'center', + textTransform: 'capitalize' as const, +}; + +const iconStyles = { + marginRight: '8px', +}; + +const STATUS_TO_COLOR: Record = { + success: 'success', + failure: 'danger', + unknown: 'gray', +}; + +export const RuleEventLogListStatus = (props: RuleEventLogListStatusProps) => { + const { status } = props; + const color = STATUS_TO_COLOR[status] || 'gray'; + + return ( +
+ + {status} +
+ ); +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status_filter.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status_filter.test.tsx new file mode 100644 index 00000000000000..bb7f87b59aa5bb --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status_filter.test.tsx @@ -0,0 +1,62 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { mountWithIntl } from '@kbn/test-jest-helpers'; +import { EuiFilterButton, EuiFilterSelectItem } from '@elastic/eui'; +import { RuleEventLogListStatusFilter } from './rule_event_log_list_status_filter'; + +const onChangeMock = jest.fn(); + +describe('rule_event_log_list_status_filter', () => { + beforeEach(() => { + onChangeMock.mockReset(); + }); + + it('renders correctly', () => { + const wrapper = mountWithIntl( + + ); + + expect(wrapper.find(EuiFilterSelectItem).exists()).toBeFalsy(); + expect(wrapper.find(EuiFilterButton).exists()).toBeTruthy(); + + expect(wrapper.find('.euiNotificationBadge').text()).toEqual('0'); + }); + + it('can open the popover correctly', () => { + const wrapper = mountWithIntl( + + ); + + wrapper.find(EuiFilterButton).simulate('click'); + + const statusItems = wrapper.find(EuiFilterSelectItem); + expect(statusItems.length).toEqual(3); + + statusItems.at(0).simulate('click'); + expect(onChangeMock).toHaveBeenCalledWith(['success']); + + wrapper.setProps({ + selectedOptions: ['success'], + }); + + expect(wrapper.find('.euiNotificationBadge').text()).toEqual('1'); + + statusItems.at(1).simulate('click'); + expect(onChangeMock).toHaveBeenCalledWith(['success', 'failure']); + + wrapper.setProps({ + selectedOptions: ['success', 'failure'], + }); + + expect(wrapper.find('.euiNotificationBadge').text()).toEqual('2'); + + statusItems.at(0).simulate('click'); + expect(onChangeMock).toHaveBeenCalledWith(['failure']); + }); +}); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status_filter.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status_filter.tsx new file mode 100644 index 00000000000000..85adfe90def446 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list_status_filter.tsx @@ -0,0 +1,79 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState, useCallback } from 'react'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { EuiFilterButton, EuiPopover, EuiFilterGroup, EuiFilterSelectItem } from '@elastic/eui'; +import { EcsEventOutcome } from 'kibana/server'; +import { RuleEventLogListStatus } from './rule_event_log_list_status'; + +const statusFilters: EcsEventOutcome[] = ['success', 'failure', 'unknown']; + +interface RuleEventLogListStatusFilterProps { + selectedOptions: string[]; + onChange: (selectedValues: string[]) => void; +} + +export const RuleEventLogListStatusFilter = (props: RuleEventLogListStatusFilterProps) => { + const { selectedOptions = [], onChange = () => {} } = props; + + const [isPopoverOpen, setIsPopoverOpen] = useState(false); + + const onFilterItemClick = useCallback( + (newOption: string) => () => { + if (selectedOptions.includes(newOption)) { + onChange(selectedOptions.filter((option) => option !== newOption)); + return; + } + onChange([...selectedOptions, newOption]); + }, + [selectedOptions, onChange] + ); + + const onClick = useCallback(() => { + setIsPopoverOpen((prevIsOpen) => !prevIsOpen); + }, [setIsPopoverOpen]); + + return ( + + setIsPopoverOpen(false)} + button={ + 0} + numActiveFilters={selectedOptions.length} + numFilters={selectedOptions.length} + onClick={onClick} + > + + + } + > + <> + {statusFilters.map((status) => { + return ( + + + + ); + })} + + + + ); +}; diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/types.ts b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/types.ts new file mode 100644 index 00000000000000..0a4b706c8676e5 --- /dev/null +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/types.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export interface AlertListItemStatus { + label: string; + healthColor: string; + actionGroup?: string; +} + +export interface AlertListItem { + alert: string; + status: AlertListItemStatus; + start?: Date; + duration: number; + isMuted: boolean; + sortPriority: number; +} diff --git a/x-pack/plugins/triggers_actions_ui/public/common/get_experimental_features.test.tsx b/x-pack/plugins/triggers_actions_ui/public/common/get_experimental_features.test.tsx index 23d77b6e07a9bb..0b865eb5b61be2 100644 --- a/x-pack/plugins/triggers_actions_ui/public/common/get_experimental_features.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/common/get_experimental_features.test.tsx @@ -13,7 +13,7 @@ describe('getIsExperimentalFeatureEnabled', () => { ExperimentalFeaturesService.init({ experimentalFeatures: { rulesListDatagrid: true, - rulesDetailLogs: false, + rulesDetailLogs: true, }, }); @@ -23,7 +23,7 @@ describe('getIsExperimentalFeatureEnabled', () => { result = getIsExperimentalFeatureEnabled('rulesDetailLogs'); - expect(result).toEqual(false); + expect(result).toEqual(true); expect(() => getIsExperimentalFeatureEnabled('doesNotExist' as any)).toThrowError( 'Invalid enable value doesNotExist. Allowed values are: rulesListDatagrid, rulesDetailLogs' diff --git a/x-pack/plugins/uptime/common/constants/monitor_management.ts b/x-pack/plugins/uptime/common/constants/monitor_management.ts new file mode 100644 index 00000000000000..c306d939c71281 --- /dev/null +++ b/x-pack/plugins/uptime/common/constants/monitor_management.ts @@ -0,0 +1,91 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +// values must match keys in the integration package +export enum ConfigKey { + APM_SERVICE_NAME = 'service.name', + ENABLED = 'enabled', + HOSTS = 'hosts', + IGNORE_HTTPS_ERRORS = 'ignore_https_errors', + JOURNEY_FILTERS_MATCH = 'filter_journeys.match', + JOURNEY_FILTERS_TAGS = 'filter_journeys.tags', + MAX_REDIRECTS = 'max_redirects', + METADATA = '__ui', + MONITOR_TYPE = 'type', + NAME = 'name', + NAMESPACE = 'namespace', + LOCATIONS = 'locations', + PARAMS = 'params', + PASSWORD = 'password', + PROXY_URL = 'proxy_url', + PROXY_USE_LOCAL_RESOLVER = 'proxy_use_local_resolver', + RESPONSE_BODY_CHECK_NEGATIVE = 'check.response.body.negative', + RESPONSE_BODY_CHECK_POSITIVE = 'check.response.body.positive', + RESPONSE_BODY_INDEX = 'response.include_body', + RESPONSE_HEADERS_CHECK = 'check.response.headers', + RESPONSE_HEADERS_INDEX = 'response.include_headers', + RESPONSE_RECEIVE_CHECK = 'check.receive', + RESPONSE_STATUS_CHECK = 'check.response.status', + REQUEST_BODY_CHECK = 'check.request.body', + REQUEST_HEADERS_CHECK = 'check.request.headers', + REQUEST_METHOD_CHECK = 'check.request.method', + REQUEST_SEND_CHECK = 'check.send', + REVISION = 'revision', + SCHEDULE = 'schedule', + SCREENSHOTS = 'screenshots', + SOURCE_INLINE = 'source.inline.script', + SOURCE_ZIP_URL = 'source.zip_url.url', + SOURCE_ZIP_USERNAME = 'source.zip_url.username', + SOURCE_ZIP_PASSWORD = 'source.zip_url.password', + SOURCE_ZIP_FOLDER = 'source.zip_url.folder', + SOURCE_ZIP_PROXY_URL = 'source.zip_url.proxy_url', + SYNTHETICS_ARGS = 'synthetics_args', + TLS_CERTIFICATE_AUTHORITIES = 'ssl.certificate_authorities', + TLS_CERTIFICATE = 'ssl.certificate', + TLS_KEY = 'ssl.key', + TLS_KEY_PASSPHRASE = 'ssl.key_passphrase', + TLS_VERIFICATION_MODE = 'ssl.verification_mode', + TLS_VERSION = 'ssl.supported_protocols', + TAGS = 'tags', + TIMEOUT = 'timeout', + THROTTLING_CONFIG = 'throttling.config', + IS_THROTTLING_ENABLED = 'throttling.is_enabled', + DOWNLOAD_SPEED = 'throttling.download_speed', + UPLOAD_SPEED = 'throttling.upload_speed', + LATENCY = 'throttling.latency', + URLS = 'urls', + PORT = 'url.port', + USERNAME = 'username', + WAIT = 'wait', + ZIP_URL_TLS_CERTIFICATE_AUTHORITIES = 'source.zip_url.ssl.certificate_authorities', + ZIP_URL_TLS_CERTIFICATE = 'source.zip_url.ssl.certificate', + ZIP_URL_TLS_KEY = 'source.zip_url.ssl.key', + ZIP_URL_TLS_KEY_PASSPHRASE = 'source.zip_url.ssl.key_passphrase', + ZIP_URL_TLS_VERIFICATION_MODE = 'source.zip_url.ssl.verification_mode', + ZIP_URL_TLS_VERSION = 'source.zip_url.ssl.supported_protocols', +} + +export const secretKeys = [ + ConfigKey.PARAMS, + ConfigKey.PASSWORD, + ConfigKey.REQUEST_BODY_CHECK, + ConfigKey.REQUEST_HEADERS_CHECK, + ConfigKey.REQUEST_SEND_CHECK, + ConfigKey.RESPONSE_BODY_CHECK_NEGATIVE, + ConfigKey.RESPONSE_BODY_CHECK_POSITIVE, + ConfigKey.RESPONSE_HEADERS_CHECK, + ConfigKey.RESPONSE_RECEIVE_CHECK, + ConfigKey.SOURCE_INLINE, + ConfigKey.SOURCE_ZIP_USERNAME, + ConfigKey.SOURCE_ZIP_PASSWORD, + ConfigKey.SYNTHETICS_ARGS, + ConfigKey.TLS_KEY, + ConfigKey.TLS_KEY_PASSPHRASE, + ConfigKey.USERNAME, + ConfigKey.ZIP_URL_TLS_KEY, + ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE, +] as const; diff --git a/x-pack/plugins/uptime/common/runtime_types/monitor_management/config_key.ts b/x-pack/plugins/uptime/common/runtime_types/monitor_management/config_key.ts index c3a6697d68b62e..52cdbd08f06c99 100644 --- a/x-pack/plugins/uptime/common/runtime_types/monitor_management/config_key.ts +++ b/x-pack/plugins/uptime/common/runtime_types/monitor_management/config_key.ts @@ -7,70 +7,8 @@ import * as t from 'io-ts'; import { tEnum } from '../../utils/t_enum'; - -// values must match keys in the integration package -export enum ConfigKey { - APM_SERVICE_NAME = 'service.name', - ENABLED = 'enabled', - HOSTS = 'hosts', - IGNORE_HTTPS_ERRORS = 'ignore_https_errors', - JOURNEY_FILTERS_MATCH = 'filter_journeys.match', - JOURNEY_FILTERS_TAGS = 'filter_journeys.tags', - MAX_REDIRECTS = 'max_redirects', - METADATA = '__ui', - MONITOR_TYPE = 'type', - NAME = 'name', - NAMESPACE = 'namespace', - LOCATIONS = 'locations', - PARAMS = 'params', - PASSWORD = 'password', - PROXY_URL = 'proxy_url', - PROXY_USE_LOCAL_RESOLVER = 'proxy_use_local_resolver', - RESPONSE_BODY_CHECK_NEGATIVE = 'check.response.body.negative', - RESPONSE_BODY_CHECK_POSITIVE = 'check.response.body.positive', - RESPONSE_BODY_INDEX = 'response.include_body', - RESPONSE_HEADERS_CHECK = 'check.response.headers', - RESPONSE_HEADERS_INDEX = 'response.include_headers', - RESPONSE_RECEIVE_CHECK = 'check.receive', - RESPONSE_STATUS_CHECK = 'check.response.status', - REQUEST_BODY_CHECK = 'check.request.body', - REQUEST_HEADERS_CHECK = 'check.request.headers', - REQUEST_METHOD_CHECK = 'check.request.method', - REQUEST_SEND_CHECK = 'check.send', - REVISION = 'revision', - SCHEDULE = 'schedule', - SCREENSHOTS = 'screenshots', - SOURCE_INLINE = 'source.inline.script', - SOURCE_ZIP_URL = 'source.zip_url.url', - SOURCE_ZIP_USERNAME = 'source.zip_url.username', - SOURCE_ZIP_PASSWORD = 'source.zip_url.password', - SOURCE_ZIP_FOLDER = 'source.zip_url.folder', - SOURCE_ZIP_PROXY_URL = 'source.zip_url.proxy_url', - SYNTHETICS_ARGS = 'synthetics_args', - TLS_CERTIFICATE_AUTHORITIES = 'ssl.certificate_authorities', - TLS_CERTIFICATE = 'ssl.certificate', - TLS_KEY = 'ssl.key', - TLS_KEY_PASSPHRASE = 'ssl.key_passphrase', - TLS_VERIFICATION_MODE = 'ssl.verification_mode', - TLS_VERSION = 'ssl.supported_protocols', - TAGS = 'tags', - TIMEOUT = 'timeout', - THROTTLING_CONFIG = 'throttling.config', - IS_THROTTLING_ENABLED = 'throttling.is_enabled', - DOWNLOAD_SPEED = 'throttling.download_speed', - UPLOAD_SPEED = 'throttling.upload_speed', - LATENCY = 'throttling.latency', - URLS = 'urls', - PORT = 'url.port', - USERNAME = 'username', - WAIT = 'wait', - ZIP_URL_TLS_CERTIFICATE_AUTHORITIES = 'source.zip_url.ssl.certificate_authorities', - ZIP_URL_TLS_CERTIFICATE = 'source.zip_url.ssl.certificate', - ZIP_URL_TLS_KEY = 'source.zip_url.ssl.key', - ZIP_URL_TLS_KEY_PASSPHRASE = 'source.zip_url.ssl.key_passphrase', - ZIP_URL_TLS_VERIFICATION_MODE = 'source.zip_url.ssl.verification_mode', - ZIP_URL_TLS_VERSION = 'source.zip_url.ssl.supported_protocols', -} +import { ConfigKey } from '../../constants/monitor_management'; +export { ConfigKey } from '../../constants/monitor_management'; export const ConfigKeyCodec = tEnum('ConfigKey', ConfigKey); export type ConfigKeyType = t.TypeOf; diff --git a/x-pack/plugins/uptime/common/runtime_types/monitor_management/monitor_types.ts b/x-pack/plugins/uptime/common/runtime_types/monitor_management/monitor_types.ts index e0205b9362e232..44c643d2160d14 100644 --- a/x-pack/plugins/uptime/common/runtime_types/monitor_management/monitor_types.ts +++ b/x-pack/plugins/uptime/common/runtime_types/monitor_management/monitor_types.ts @@ -6,6 +6,7 @@ */ import * as t from 'io-ts'; +import { secretKeys } from '../../constants/monitor_management'; import { ConfigKey } from './config_key'; import { LocationsCodec } from './locations'; import { @@ -27,25 +28,35 @@ const Schedule = t.interface({ export const TLSFieldsCodec = t.partial({ [ConfigKey.TLS_CERTIFICATE_AUTHORITIES]: t.string, [ConfigKey.TLS_CERTIFICATE]: t.string, - [ConfigKey.TLS_KEY]: t.string, - [ConfigKey.TLS_KEY_PASSPHRASE]: t.string, [ConfigKey.TLS_VERIFICATION_MODE]: VerificationModeCodec, [ConfigKey.TLS_VERSION]: t.array(TLSVersionCodec), }); -export type TLSFields = t.TypeOf; +export const TLSSensitiveFieldsCodec = t.partial({ + [ConfigKey.TLS_KEY]: t.string, + [ConfigKey.TLS_KEY_PASSPHRASE]: t.string, +}); + +export const TLSCodec = t.intersection([TLSFieldsCodec, TLSSensitiveFieldsCodec]); + +export type TLSFields = t.TypeOf; // ZipUrlTLSFields export const ZipUrlTLSFieldsCodec = t.partial({ [ConfigKey.ZIP_URL_TLS_CERTIFICATE_AUTHORITIES]: t.string, [ConfigKey.ZIP_URL_TLS_CERTIFICATE]: t.string, - [ConfigKey.ZIP_URL_TLS_KEY]: t.string, - [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: t.string, [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: VerificationModeCodec, [ConfigKey.ZIP_URL_TLS_VERSION]: t.array(TLSVersionCodec), }); -export type ZipUrlTLSFields = t.TypeOf; +export const ZipUrlTLSSensitiveFieldsCodec = t.partial({ + [ConfigKey.ZIP_URL_TLS_KEY]: t.string, + [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: t.string, +}); + +export const ZipUrlTLSCodec = t.intersection([ZipUrlTLSFieldsCodec, ZipUrlTLSSensitiveFieldsCodec]); + +export type ZipUrlTLSFields = t.TypeOf; // CommonFields export const CommonFieldsCodec = t.intersection([ @@ -82,19 +93,33 @@ export type TCPSimpleFields = t.TypeOf; export const TCPAdvancedFieldsCodec = t.interface({ [ConfigKey.PROXY_URL]: t.string, [ConfigKey.PROXY_USE_LOCAL_RESOLVER]: t.boolean, +}); + +export const TCPSensitiveAdvancedFieldsCodec = t.interface({ [ConfigKey.RESPONSE_RECEIVE_CHECK]: t.string, [ConfigKey.REQUEST_SEND_CHECK]: t.string, }); -export type TCPAdvancedFields = t.TypeOf; +export const TCPAdvancedCodec = t.intersection([ + TCPAdvancedFieldsCodec, + TCPSensitiveAdvancedFieldsCodec, +]); + +export type TCPAdvancedFields = t.TypeOf; // TCPFields -export const TCPFieldsCodec = t.intersection([ +export const EncryptedTCPFieldsCodec = t.intersection([ TCPSimpleFieldsCodec, TCPAdvancedFieldsCodec, TLSFieldsCodec, ]); +export const TCPFieldsCodec = t.intersection([ + EncryptedTCPFieldsCodec, + TCPSensitiveAdvancedFieldsCodec, + TLSSensitiveFieldsCodec, +]); + export type TCPFields = t.TypeOf; // ICMP SimpleFields @@ -123,28 +148,43 @@ export type HTTPSimpleFields = t.TypeOf; // HTTPAdvancedFields export const HTTPAdvancedFieldsCodec = t.interface({ - [ConfigKey.PASSWORD]: t.string, [ConfigKey.PROXY_URL]: t.string, - [ConfigKey.RESPONSE_BODY_CHECK_NEGATIVE]: t.array(t.string), - [ConfigKey.RESPONSE_BODY_CHECK_POSITIVE]: t.array(t.string), [ConfigKey.RESPONSE_BODY_INDEX]: ResponseBodyIndexPolicyCodec, - [ConfigKey.RESPONSE_HEADERS_CHECK]: t.record(t.string, t.string), [ConfigKey.RESPONSE_HEADERS_INDEX]: t.boolean, [ConfigKey.RESPONSE_STATUS_CHECK]: t.array(t.string), + [ConfigKey.REQUEST_METHOD_CHECK]: t.string, +}); + +export const HTTPSensitiveAdvancedFieldsCodec = t.interface({ + [ConfigKey.PASSWORD]: t.string, + [ConfigKey.RESPONSE_BODY_CHECK_NEGATIVE]: t.array(t.string), + [ConfigKey.RESPONSE_BODY_CHECK_POSITIVE]: t.array(t.string), + [ConfigKey.RESPONSE_HEADERS_CHECK]: t.record(t.string, t.string), [ConfigKey.REQUEST_BODY_CHECK]: t.interface({ value: t.string, type: ModeCodec }), [ConfigKey.REQUEST_HEADERS_CHECK]: t.record(t.string, t.string), - [ConfigKey.REQUEST_METHOD_CHECK]: t.string, [ConfigKey.USERNAME]: t.string, }); -export type HTTPAdvancedFields = t.TypeOf; +export const HTTPAdvancedCodec = t.intersection([ + HTTPAdvancedFieldsCodec, + HTTPSensitiveAdvancedFieldsCodec, +]); + +export type HTTPAdvancedFields = t.TypeOf; // HTTPFields -export const HTTPFieldsCodec = t.intersection([ +export const EncryptedHTTPFieldsCodec = t.intersection([ HTTPSimpleFieldsCodec, HTTPAdvancedFieldsCodec, TLSFieldsCodec, ]); + +export const HTTPFieldsCodec = t.intersection([ + EncryptedHTTPFieldsCodec, + HTTPSensitiveAdvancedFieldsCodec, + TLSSensitiveFieldsCodec, +]); + export type HTTPFields = t.TypeOf; // Browser Fields @@ -156,15 +196,23 @@ export const ThrottlingConfigKeyCodec = t.union([ export type ThrottlingConfigKey = t.TypeOf; -export const BrowserSimpleFieldsCodec = t.intersection([ +export const EncryptedBrowserSimpleFieldsCodec = t.intersection([ t.interface({ [ConfigKey.METADATA]: MetadataCodec, - [ConfigKey.SOURCE_INLINE]: t.string, [ConfigKey.SOURCE_ZIP_URL]: t.string, [ConfigKey.SOURCE_ZIP_FOLDER]: t.string, + [ConfigKey.SOURCE_ZIP_PROXY_URL]: t.string, + }), + ZipUrlTLSFieldsCodec, + ZipUrlTLSSensitiveFieldsCodec, + CommonFieldsCodec, +]); + +export const BrowserSensitiveSimpleFieldsCodec = t.intersection([ + t.interface({ + [ConfigKey.SOURCE_INLINE]: t.string, [ConfigKey.SOURCE_ZIP_USERNAME]: t.string, [ConfigKey.SOURCE_ZIP_PASSWORD]: t.string, - [ConfigKey.SOURCE_ZIP_PROXY_URL]: t.string, [ConfigKey.PARAMS]: t.string, [ConfigKey.URLS]: t.union([t.string, t.undefined]), [ConfigKey.PORT]: t.union([t.number, t.undefined]), @@ -174,7 +222,6 @@ export const BrowserSimpleFieldsCodec = t.intersection([ ]); export const BrowserAdvancedFieldsCodec = t.interface({ - [ConfigKey.SYNTHETICS_ARGS]: t.array(t.string), [ConfigKey.SCREENSHOTS]: t.string, [ConfigKey.JOURNEY_FILTERS_MATCH]: t.string, [ConfigKey.JOURNEY_FILTERS_TAGS]: t.array(t.string), @@ -186,14 +233,35 @@ export const BrowserAdvancedFieldsCodec = t.interface({ [ConfigKey.THROTTLING_CONFIG]: t.string, }); +export const BrowserSimpleFieldsCodec = t.intersection([ + EncryptedBrowserSimpleFieldsCodec, + BrowserSensitiveSimpleFieldsCodec, + ZipUrlTLSSensitiveFieldsCodec, +]); + +export const BrowserSensitiveAdvancedFieldsCodec = t.interface({ + [ConfigKey.SYNTHETICS_ARGS]: t.array(t.string), +}); + +export const BrowserAdvancedsCodec = t.intersection([ + BrowserAdvancedFieldsCodec, + BrowserSensitiveAdvancedFieldsCodec, +]); + +export const EncryptedBrowserFieldsCodec = t.intersection([ + EncryptedBrowserSimpleFieldsCodec, + BrowserAdvancedFieldsCodec, +]); + export const BrowserFieldsCodec = t.intersection([ BrowserSimpleFieldsCodec, BrowserAdvancedFieldsCodec, + BrowserSensitiveAdvancedFieldsCodec, ]); export type BrowserFields = t.TypeOf; export type BrowserSimpleFields = t.TypeOf; -export type BrowserAdvancedFields = t.TypeOf; +export type BrowserAdvancedFields = t.TypeOf; // MonitorFields, represents any possible monitor type export const MonitorFieldsCodec = t.intersection([ @@ -213,17 +281,34 @@ export const SyntheticsMonitorCodec = t.union([ BrowserFieldsCodec, ]); +export const EncryptedSyntheticsMonitorCodec = t.union([ + EncryptedHTTPFieldsCodec, + EncryptedTCPFieldsCodec, + ICMPSimpleFieldsCodec, + EncryptedBrowserFieldsCodec, +]); + export type SyntheticsMonitor = t.TypeOf; export const SyntheticsMonitorWithIdCodec = t.intersection([ SyntheticsMonitorCodec, t.interface({ id: t.string }), ]); + +export const EncryptedSyntheticsMonitorWithIdCodec = t.intersection([ + EncryptedSyntheticsMonitorCodec, + t.interface({ id: t.string }), +]); + export type SyntheticsMonitorWithId = t.TypeOf; +export type EncryptedSyntheticsMonitorWithId = t.TypeOf< + typeof EncryptedSyntheticsMonitorWithIdCodec +>; + export const MonitorManagementListResultCodec = t.type({ monitors: t.array( - t.interface({ id: t.string, attributes: SyntheticsMonitorCodec, updated_at: t.string }) + t.interface({ id: t.string, attributes: EncryptedSyntheticsMonitorCodec, updated_at: t.string }) ), page: t.number, perPage: t.number, @@ -231,3 +316,19 @@ export const MonitorManagementListResultCodec = t.type({ }); export type MonitorManagementListResult = t.TypeOf; + +export const SyntheticsMonitorWithSecretsCodec = t.intersection([ + EncryptedSyntheticsMonitorCodec, + t.interface({ + secrets: t.string, + }), +]); + +export type Secret = typeof secretKeys[number]; + +export type SyntheticsMonitorWithSecrets = Omit< + t.TypeOf, + Secret +>; + +export type EncryptedSyntheticsMonitor = Omit; diff --git a/x-pack/plugins/uptime/common/types/synthetics_monitor.ts b/x-pack/plugins/uptime/common/types/synthetics_monitor.ts index f4f20fda9235ff..2fba9e0c299aa6 100644 --- a/x-pack/plugins/uptime/common/types/synthetics_monitor.ts +++ b/x-pack/plugins/uptime/common/types/synthetics_monitor.ts @@ -6,13 +6,17 @@ */ import { SimpleSavedObject } from 'kibana/public'; -import { SyntheticsMonitor } from '../runtime_types'; +import { EncryptedSyntheticsMonitor, SyntheticsMonitor } from '../runtime_types'; export interface MonitorIdParam { monitorId: string; } -export type SyntheticsMonitorSavedObject = SimpleSavedObject & { +export type SyntheticsMonitorSavedObject = SimpleSavedObject & { + updated_at: string; +}; + +export type DecryptedSyntheticsMonitorSavedObject = SimpleSavedObject & { updated_at: string; }; diff --git a/x-pack/plugins/uptime/e2e/tasks/uptime_monitor.ndjson b/x-pack/plugins/uptime/e2e/tasks/uptime_monitor.ndjson index e0088725d6e696..308be283a86b87 100644 --- a/x-pack/plugins/uptime/e2e/tasks/uptime_monitor.ndjson +++ b/x-pack/plugins/uptime/e2e/tasks/uptime_monitor.ndjson @@ -1,3 +1,3 @@ -{"attributes":{"__ui":{"is_tls_enabled":false,"is_zip_url_tls_enabled":false},"check.request.body":{"type":"text","value":""},"check.request.headers":{},"check.request.method":"GET","check.response.body.negative":[],"check.response.body.positive":[],"check.response.headers":{},"check.response.status":[],"enabled":true,"locations":[{"geo":{"lat":41.25,"lon":-95.86},"id":"us_central","label":"US Central","url":"https://us-central.synthetics.elastic.dev"}],"max_redirects":"0","name":"Test Monitor","password":"4SdnK70F8YLqril8Mh5qVveP","proxy_url":"","response.include_body":"on_error","response.include_headers":true,"schedule":{"number":"3","unit":"m"},"service.name":"","tags":[],"timeout":"16","type":"http","urls":"https://www.google.com","username":""},"coreMigrationVersion":"8.1.0","id":"832b9980-7fba-11ec-b360-25a79ce3f496","references":[],"sort":[1643319958480,20371],"type":"synthetics-monitor","updated_at":"2022-01-27T21:45:58.480Z","version":"WzExOTg3ODYsMl0="} -{"attributes":{"__ui":{"is_tls_enabled":false,"is_zip_url_tls_enabled":false},"check.request.body":{"type":"text","value":""},"check.request.headers":{},"check.request.method":"GET","check.response.body.negative":[],"check.response.body.positive":[],"check.response.headers":{},"check.response.status":[],"enabled":true,"locations":[{"geo":{"lat":41.25,"lon":-95.86},"id":"us_central","label":"US Central","url":"https://us-central.synthetics.elastic.dev"}],"max_redirects":"0","name":"Test Monito","password":"4SdnK70F8YLqril8Mh5qVveP","proxy_url":"","response.include_body":"on_error","response.include_headers":true,"schedule":{"number":"3","unit":"m"},"service.name":"","tags":[],"timeout":"16","type":"http","urls":"https://www.google.com","username":""},"coreMigrationVersion":"8.1.0","id":"b28380d0-7fba-11ec-b360-25a79ce3f496","references":[],"sort":[1643320037906,20374],"type":"synthetics-monitor","updated_at":"2022-01-27T21:47:17.906Z","version":"WzExOTg4MDAsMl0="} +{"attributes":{"__ui":{"is_tls_enabled":false,"is_zip_url_tls_enabled":false},"check.request.method":"GET","check.response.status":[],"enabled":true,"locations":[{"geo":{"lat":41.25,"lon":-95.86},"id":"us_central","label":"US Central","url":"https://us-central.synthetics.elastic.dev"}],"max_redirects":"0","name":"Test Monitor","proxy_url":"","response.include_body":"on_error","response.include_headers":true,"schedule":{"number":"3","unit":"m"},"service.name":"","tags":[],"timeout":"16","type":"http","urls":"https://www.google.com", "secrets": "{}"},"coreMigrationVersion":"8.1.0","id":"832b9980-7fba-11ec-b360-25a79ce3f496","references":[],"sort":[1643319958480,20371],"type":"synthetics-monitor","updated_at":"2022-01-27T21:45:58.480Z","version":"WzExOTg3ODYsMl0="} +{"attributes":{"__ui":{"is_tls_enabled":false,"is_zip_url_tls_enabled":false},"check.request.method":"GET","check.response.status":[],"enabled":true,"locations":[{"geo":{"lat":41.25,"lon":-95.86},"id":"us_central","label":"US Central","url":"https://us-central.synthetics.elastic.dev"}],"max_redirects":"0","name":"Test Monito","proxy_url":"","response.include_body":"on_error","response.include_headers":true,"schedule":{"number":"3","unit":"m"},"service.name":"","tags":[],"timeout":"16","type":"http","urls":"https://www.google.com", "secrets": "{}"},"coreMigrationVersion":"8.1.0","id":"b28380d0-7fba-11ec-b360-25a79ce3f496","references":[],"sort":[1643320037906,20374],"type":"synthetics-monitor","updated_at":"2022-01-27T21:47:17.906Z","version":"WzExOTg4MDAsMl0="} {"excludedObjects":[],"excludedObjectsCount":0,"exportedCount":2,"missingRefCount":0,"missingReferences":[]} \ No newline at end of file diff --git a/x-pack/plugins/uptime/public/components/monitor_management/monitor_list/monitor_enabled.tsx b/x-pack/plugins/uptime/public/components/monitor_management/monitor_list/monitor_enabled.tsx index 2913043aca72ea..00d146a8f44b4a 100644 --- a/x-pack/plugins/uptime/public/components/monitor_management/monitor_list/monitor_enabled.tsx +++ b/x-pack/plugins/uptime/public/components/monitor_management/monitor_list/monitor_enabled.tsx @@ -10,12 +10,12 @@ import { i18n } from '@kbn/i18n'; import React, { useEffect, useState } from 'react'; import { useKibana } from '../../../../../../../src/plugins/kibana_react/public'; import { FETCH_STATUS, useFetcher } from '../../../../../observability/public'; -import { ConfigKey, SyntheticsMonitor } from '../../../../common/runtime_types'; +import { ConfigKey, EncryptedSyntheticsMonitor } from '../../../../common/runtime_types'; import { setMonitor } from '../../../state/api'; interface Props { id: string; - monitor: SyntheticsMonitor; + monitor: EncryptedSyntheticsMonitor; onUpdate: () => void; isDisabled?: boolean; } diff --git a/x-pack/plugins/uptime/public/components/monitor_management/monitor_list/monitor_list.tsx b/x-pack/plugins/uptime/public/components/monitor_management/monitor_list/monitor_list.tsx index 8bae4160f6b0c7..559e84d2dd8276 100644 --- a/x-pack/plugins/uptime/public/components/monitor_management/monitor_list/monitor_list.tsx +++ b/x-pack/plugins/uptime/public/components/monitor_management/monitor_list/monitor_list.tsx @@ -23,7 +23,7 @@ import { MonitorFields, Ping, ServiceLocations, - SyntheticsMonitorWithId, + EncryptedSyntheticsMonitorWithId, TCPSimpleFields, } from '../../../../common/runtime_types'; import { UptimeSettingsContext } from '../../../contexts'; @@ -66,7 +66,7 @@ export const MonitorManagementList = ({ const isXl = useBreakpoints().up('xl'); const { total } = list as MonitorManagementListState['list']; - const monitors: SyntheticsMonitorWithId[] = useMemo( + const monitors: EncryptedSyntheticsMonitorWithId[] = useMemo( () => list.monitors.map((monitor) => ({ ...monitor.attributes, @@ -79,7 +79,7 @@ export const MonitorManagementList = ({ ({ page = { index: 0, size: 10 }, sort = { field: ConfigKey.NAME, direction: 'asc' }, - }: Criteria) => { + }: Criteria) => { const { index, size } = page; const { field, direction } = sort; @@ -100,9 +100,9 @@ export const MonitorManagementList = ({ pageSizeOptions: [5, 10, 25, 50, 100], }; - const sorting: EuiTableSortingType = { + const sorting: EuiTableSortingType = { sort: { - field: sortField as keyof SyntheticsMonitorWithId, + field: sortField as keyof EncryptedSyntheticsMonitorWithId, direction: sortOrder, }, }; @@ -117,7 +117,7 @@ export const MonitorManagementList = ({ defaultMessage: 'Monitor name', }), sortable: true, - render: (name: string, { id }: SyntheticsMonitorWithId) => ( + render: (name: string, { id }: EncryptedSyntheticsMonitorWithId) => ( @@ -175,7 +175,7 @@ export const MonitorManagementList = ({ name: i18n.translate('xpack.uptime.monitorManagement.monitorList.enabled', { defaultMessage: 'Enabled', }), - render: (_enabled: boolean, monitor: SyntheticsMonitorWithId) => ( + render: (_enabled: boolean, monitor: EncryptedSyntheticsMonitorWithId) => ( ( + render: (fields: EncryptedSyntheticsMonitorWithId) => ( ), }, - ] as Array>; + ] as Array>; return ( diff --git a/x-pack/plugins/uptime/public/pages/monitor_management/edit_monitor.tsx b/x-pack/plugins/uptime/public/pages/monitor_management/edit_monitor.tsx index 0ebf1d6286db60..7ebfbb2297d0ae 100644 --- a/x-pack/plugins/uptime/public/pages/monitor_management/edit_monitor.tsx +++ b/x-pack/plugins/uptime/public/pages/monitor_management/edit_monitor.tsx @@ -13,7 +13,7 @@ import { MonitorFields } from '../../../common/runtime_types'; import { EditMonitorConfig } from '../../components/monitor_management/edit_monitor_config'; import { Loader } from '../../components/monitor_management/loader/loader'; import { getMonitor } from '../../state/api'; -import { SyntheticsMonitorSavedObject } from '../../../common/types'; +import { DecryptedSyntheticsMonitorSavedObject } from '../../../common/types'; import { useLocations } from '../../components/monitor_management/hooks/use_locations'; import { useMonitorManagementBreadcrumbs } from './use_monitor_management_breadcrumbs'; @@ -23,7 +23,9 @@ export const EditMonitorPage: React.FC = () => { useMonitorManagementBreadcrumbs({ isEditMonitor: true }); const { monitorId } = useParams<{ monitorId: string }>(); - const { data, status } = useFetcher>(() => { + const { data, status } = useFetcher< + Promise + >(() => { return getMonitor({ id: Buffer.from(monitorId, 'base64').toString('utf8') }); }, [monitorId]); diff --git a/x-pack/plugins/uptime/public/state/api/monitor_management.ts b/x-pack/plugins/uptime/public/state/api/monitor_management.ts index 329c06e6ceadce..f9e08e30209366 100644 --- a/x-pack/plugins/uptime/public/state/api/monitor_management.ts +++ b/x-pack/plugins/uptime/public/state/api/monitor_management.ts @@ -12,18 +12,22 @@ import { MonitorManagementListResult, ServiceLocations, SyntheticsMonitor, + EncryptedSyntheticsMonitor, ServiceLocationsApiResponseCodec, ServiceLocationErrors, ThrottlingOptions, } from '../../../common/runtime_types'; -import { SyntheticsMonitorSavedObject, SyntheticsServiceAllowed } from '../../../common/types'; +import { + DecryptedSyntheticsMonitorSavedObject, + SyntheticsServiceAllowed, +} from '../../../common/types'; import { apiService } from './utils'; export const setMonitor = async ({ monitor, id, }: { - monitor: SyntheticsMonitor; + monitor: SyntheticsMonitor | EncryptedSyntheticsMonitor; id?: string; }): Promise<{ attributes: { errors: ServiceLocationErrors } } | SyntheticsMonitor> => { if (id) { @@ -33,7 +37,11 @@ export const setMonitor = async ({ } }; -export const getMonitor = async ({ id }: { id: string }): Promise => { +export const getMonitor = async ({ + id, +}: { + id: string; +}): Promise => { return await apiService.get(`${API_URLS.SYNTHETICS_MONITORS}/${id}`); }; diff --git a/x-pack/plugins/uptime/server/lib/requests/get_monitor.ts b/x-pack/plugins/uptime/server/lib/requests/get_monitor.ts index 4f6f8682fbeacf..b74852d5813117 100644 --- a/x-pack/plugins/uptime/server/lib/requests/get_monitor.ts +++ b/x-pack/plugins/uptime/server/lib/requests/get_monitor.ts @@ -6,18 +6,38 @@ */ import { SavedObject, SavedObjectsClientContract } from 'kibana/server'; -import { SyntheticsMonitor } from '../../../common/runtime_types'; -import { syntheticsMonitorType } from '../../lib/saved_objects/synthetics_monitor'; +import { EncryptedSavedObjectsClient } from '../../../../encrypted_saved_objects/server'; +import { + SyntheticsMonitorWithSecrets, + EncryptedSyntheticsMonitor, +} from '../../../common/runtime_types'; +import { + syntheticsMonitor, + syntheticsMonitorType, +} from '../../lib/saved_objects/synthetics_monitor'; export const getSyntheticsMonitor = async ({ monitorId, + encryptedSavedObjectsClient, savedObjectsClient, }: { monitorId: string; + encryptedSavedObjectsClient: EncryptedSavedObjectsClient; savedObjectsClient: SavedObjectsClientContract; -}): Promise> => { +}): Promise> => { try { - return await savedObjectsClient.get(syntheticsMonitorType, monitorId); + const encryptedMonitor = await savedObjectsClient.get( + syntheticsMonitorType, + monitorId + ); + + return await encryptedSavedObjectsClient.getDecryptedAsInternalUser( + syntheticsMonitor.name, + monitorId, + { + namespace: encryptedMonitor.namespaces?.[0], + } + ); } catch (e) { throw e; } diff --git a/x-pack/plugins/uptime/server/lib/saved_objects/saved_objects.ts b/x-pack/plugins/uptime/server/lib/saved_objects/saved_objects.ts index 67f05bfb55d031..74f3a4a8f73668 100644 --- a/x-pack/plugins/uptime/server/lib/saved_objects/saved_objects.ts +++ b/x-pack/plugins/uptime/server/lib/saved_objects/saved_objects.ts @@ -12,6 +12,7 @@ import { import { EncryptedSavedObjectsPluginSetup } from '../../../../encrypted_saved_objects/server'; import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../common/constants'; +import { secretKeys } from '../../../common/constants/monitor_management'; import { DynamicSettings } from '../../../common/runtime_types'; import { UMSavedObjectsQueryFn } from '../adapters'; import { UptimeConfig } from '../../../common/config'; @@ -34,6 +35,20 @@ export const registerUptimeSavedObjects = ( type: syntheticsServiceApiKey.name, attributesToEncrypt: new Set(['apiKey']), }); + + encryptedSavedObjects.registerType({ + type: syntheticsMonitor.name, + attributesToEncrypt: new Set([ + 'secrets', + /* adding secretKeys to the list of attributes to encrypt ensures + * that secrets are never stored on the resulting saved object, + * even in the presence of developer error. + * + * In practice, all secrets should be stored as a single JSON + * payload on the `secrets` key. This ensures performant decryption. */ + ...secretKeys, + ]), + }); } }; diff --git a/x-pack/plugins/uptime/server/lib/saved_objects/synthetics_monitor.ts b/x-pack/plugins/uptime/server/lib/saved_objects/synthetics_monitor.ts index 88e9ad6f7f0fb3..ea20c4c9232e9b 100644 --- a/x-pack/plugins/uptime/server/lib/saved_objects/synthetics_monitor.ts +++ b/x-pack/plugins/uptime/server/lib/saved_objects/synthetics_monitor.ts @@ -32,6 +32,9 @@ export const syntheticsMonitor: SavedObjectsType = { tags: { type: 'keyword', }, + secrets: { + type: 'text', + }, }, }, management: { diff --git a/x-pack/plugins/uptime/server/lib/synthetics_service/hydrate_saved_object.test.ts b/x-pack/plugins/uptime/server/lib/synthetics_service/hydrate_saved_object.test.ts index 5c493a38ac862c..68a656a9761419 100644 --- a/x-pack/plugins/uptime/server/lib/synthetics_service/hydrate_saved_object.test.ts +++ b/x-pack/plugins/uptime/server/lib/synthetics_service/hydrate_saved_object.test.ts @@ -6,7 +6,7 @@ */ import { hydrateSavedObjects } from './hydrate_saved_object'; -import { SyntheticsMonitorSavedObject } from '../../../common/types'; +import { DecryptedSyntheticsMonitorSavedObject } from '../../../common/types'; import { UptimeServerSetup } from '../adapters'; import moment from 'moment'; @@ -42,9 +42,9 @@ describe('hydrateSavedObjects', () => { ...mockMonitorTemplate, attributes: { ...mockMonitorTemplate.attributes, type }, updated_at: moment(time).subtract(1, 'hour').toISOString(), - } as SyntheticsMonitorSavedObject; + } as DecryptedSyntheticsMonitorSavedObject; - const monitors: SyntheticsMonitorSavedObject[] = [monitor]; + const monitors: DecryptedSyntheticsMonitorSavedObject[] = [monitor]; mockEsClient.search.mockResolvedValue( toKibanaResponse([ diff --git a/x-pack/plugins/uptime/server/lib/synthetics_service/hydrate_saved_object.ts b/x-pack/plugins/uptime/server/lib/synthetics_service/hydrate_saved_object.ts index 8ee9fbca885610..6002d1bd8f1ec9 100644 --- a/x-pack/plugins/uptime/server/lib/synthetics_service/hydrate_saved_object.ts +++ b/x-pack/plugins/uptime/server/lib/synthetics_service/hydrate_saved_object.ts @@ -8,14 +8,14 @@ import moment from 'moment'; import { UptimeESClient } from '../lib'; import { UptimeServerSetup } from '../adapters'; -import { SyntheticsMonitorSavedObject } from '../../../common/types'; +import { DecryptedSyntheticsMonitorSavedObject } from '../../../common/types'; import { SyntheticsMonitor, MonitorFields, Ping } from '../../../common/runtime_types'; export const hydrateSavedObjects = async ({ monitors, server, }: { - monitors: SyntheticsMonitorSavedObject[]; + monitors: DecryptedSyntheticsMonitorSavedObject[]; server: UptimeServerSetup; }) => { try { @@ -43,7 +43,7 @@ export const hydrateSavedObjects = async ({ missingInfoIds ); - const updatedObjects: SyntheticsMonitorSavedObject[] = []; + const updatedObjects: DecryptedSyntheticsMonitorSavedObject[] = []; monitors .filter((monitor) => missingInfoIds.includes(monitor.id)) .forEach((monitor) => { @@ -73,7 +73,7 @@ export const hydrateSavedObjects = async ({ updatedObjects.push({ ...monitor, attributes: resultAttributes, - } as SyntheticsMonitorSavedObject); + } as DecryptedSyntheticsMonitorSavedObject); } }); diff --git a/x-pack/plugins/uptime/server/lib/synthetics_service/synthetics_service.ts b/x-pack/plugins/uptime/server/lib/synthetics_service/synthetics_service.ts index 6027b328d44930..4a86725d137ac3 100644 --- a/x-pack/plugins/uptime/server/lib/synthetics_service/synthetics_service.ts +++ b/x-pack/plugins/uptime/server/lib/synthetics_service/synthetics_service.ts @@ -7,6 +7,7 @@ /* eslint-disable max-classes-per-file */ +import { SavedObject } from 'kibana/server'; import { KibanaRequest, Logger } from '../../../../../../src/core/server'; import { ConcreteTaskInstance, @@ -18,7 +19,7 @@ import { UptimeServerSetup } from '../adapters'; import { installSyntheticsIndexTemplates } from '../../rest_api/synthetics_service/install_index_templates'; import { SyntheticsServiceApiKey } from '../../../common/runtime_types/synthetics_service_api_key'; import { getAPIKeyForSyntheticsService } from './get_api_key'; -import { syntheticsMonitorType } from '../saved_objects/synthetics_monitor'; +import { syntheticsMonitorType, syntheticsMonitor } from '../saved_objects/synthetics_monitor'; import { getEsHosts } from './get_es_hosts'; import { ServiceConfig } from '../../../common/config'; import { ServiceAPIClient } from './service_api_client'; @@ -30,10 +31,13 @@ import { SyntheticsMonitor, ThrottlingOptions, SyntheticsMonitorWithId, + SyntheticsMonitorWithSecrets, } from '../../../common/runtime_types'; import { getServiceLocations } from './get_service_locations'; import { hydrateSavedObjects } from './hydrate_saved_object'; -import { SyntheticsMonitorSavedObject } from '../../../common/types'; +import { DecryptedSyntheticsMonitorSavedObject } from '../../../common/types'; + +import { normalizeSecrets } from './utils/secrets'; const SYNTHETICS_SERVICE_SYNC_MONITORS_TASK_TYPE = 'UPTIME:SyntheticsService:Sync-Saved-Monitor-Objects'; @@ -302,31 +306,53 @@ export class SyntheticsService { async getMonitorConfigs() { const savedObjectsClient = this.server.savedObjectsClient; + const encryptedClient = this.server.encryptedSavedObjects.getClient(); if (!savedObjectsClient?.find) { return [] as SyntheticsMonitorWithId[]; } - const findResult = await savedObjectsClient.find({ + const { saved_objects: encryptedMonitors } = await savedObjectsClient.find({ type: syntheticsMonitorType, namespaces: ['*'], perPage: 10000, }); + const start = performance.now(); + + const monitors: Array> = await Promise.all( + encryptedMonitors.map((monitor) => + encryptedClient.getDecryptedAsInternalUser( + syntheticsMonitor.name, + monitor.id + ) + ) + ); + + const end = performance.now(); + const duration = end - start; + + this.logger.debug(`Decrypted ${monitors.length} monitors. Took ${duration} milliseconds`, { + event: { + duration, + }, + monitors: monitors.length, + }); + if (this.indexTemplateExists) { // without mapping, querying won't make sense hydrateSavedObjects({ - monitors: findResult.saved_objects as unknown as SyntheticsMonitorSavedObject[], + monitors: monitors as unknown as DecryptedSyntheticsMonitorSavedObject[], server: this.server, }); } - return (findResult.saved_objects ?? []).map(({ attributes, id }) => ({ - ...attributes, - id, + return (monitors ?? []).map((monitor) => ({ + ...normalizeSecrets(monitor).attributes, + id: monitor.id, fields_under_root: true, - fields: { config_id: id }, - })) as SyntheticsMonitorWithId[]; + fields: { config_id: monitor.id }, + })); } formatConfigs(configs: SyntheticsMonitorWithId[]) { diff --git a/x-pack/plugins/uptime/server/lib/synthetics_service/utils/secrets.ts b/x-pack/plugins/uptime/server/lib/synthetics_service/utils/secrets.ts new file mode 100644 index 00000000000000..7848dbedb7fed2 --- /dev/null +++ b/x-pack/plugins/uptime/server/lib/synthetics_service/utils/secrets.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { omit, pick } from 'lodash'; +import { SavedObject } from 'kibana/server'; +import { secretKeys } from '../../../../common/constants/monitor_management'; +import { + SyntheticsMonitor, + SyntheticsMonitorWithSecrets, +} from '../../../../common/runtime_types/monitor_management'; + +export function formatSecrets(monitor: SyntheticsMonitor): SyntheticsMonitorWithSecrets { + const monitorWithoutSecrets = omit(monitor, secretKeys) as SyntheticsMonitorWithSecrets; + const secrets = pick(monitor, secretKeys); + + return { + ...monitorWithoutSecrets, + secrets: JSON.stringify(secrets), + }; +} + +export function normalizeSecrets( + monitor: SavedObject +): SavedObject { + return { + ...monitor, + attributes: { + ...monitor.attributes, + ...JSON.parse(monitor.attributes.secrets || ''), + }, + }; +} diff --git a/x-pack/plugins/uptime/server/rest_api/monitors/monitor_status.ts b/x-pack/plugins/uptime/server/rest_api/monitors/monitor_status.ts index 5089f5250f504c..1d52f2c24a7f11 100644 --- a/x-pack/plugins/uptime/server/rest_api/monitors/monitor_status.ts +++ b/x-pack/plugins/uptime/server/rest_api/monitors/monitor_status.ts @@ -21,8 +21,9 @@ export const createGetStatusBarRoute: UMRestApiRouteFactory = (libs: UMServerLib dateEnd: schema.string(), }), }, - handler: async ({ uptimeEsClient, request, server }): Promise => { + handler: async ({ uptimeEsClient, request, server, savedObjectsClient }): Promise => { const { monitorId, dateStart, dateEnd } = request.query; + const encryptedSavedObjectsClient = server.encryptedSavedObjects.getClient(); const latestMonitor = await libs.requests.getLatestMonitor({ uptimeEsClient, @@ -42,7 +43,8 @@ export const createGetStatusBarRoute: UMRestApiRouteFactory = (libs: UMServerLib try { const monitorSavedObject = await libs.requests.getSyntheticsMonitor({ monitorId, - savedObjectsClient: server.savedObjectsClient, + encryptedSavedObjectsClient, + savedObjectsClient, }); if (!monitorSavedObject) { @@ -54,7 +56,7 @@ export const createGetStatusBarRoute: UMRestApiRouteFactory = (libs: UMServerLib [ConfigKey.NAME]: name, [ConfigKey.HOSTS]: host, [ConfigKey.MONITOR_TYPE]: type, - } = monitorSavedObject.attributes as MonitorFields; + } = monitorSavedObject.attributes as Partial; return { url: { diff --git a/x-pack/plugins/uptime/server/rest_api/synthetics_service/add_monitor.ts b/x-pack/plugins/uptime/server/rest_api/synthetics_service/add_monitor.ts index ee3ef1fe6380cf..d5beeb9967b182 100644 --- a/x-pack/plugins/uptime/server/rest_api/synthetics_service/add_monitor.ts +++ b/x-pack/plugins/uptime/server/rest_api/synthetics_service/add_monitor.ts @@ -6,12 +6,17 @@ */ import { schema } from '@kbn/config-schema'; import { SavedObject } from 'kibana/server'; -import { MonitorFields, SyntheticsMonitor } from '../../../common/runtime_types'; +import { + MonitorFields, + SyntheticsMonitor, + EncryptedSyntheticsMonitor, +} from '../../../common/runtime_types'; import { UMRestApiRouteFactory } from '../types'; import { API_URLS } from '../../../common/constants'; import { syntheticsMonitorType } from '../../lib/saved_objects/synthetics_monitor'; import { validateMonitor } from './monitor_validation'; import { sendTelemetryEvents, formatTelemetryEvent } from './telemetry/monitor_upgrade_sender'; +import { formatSecrets } from '../../lib/synthetics_service/utils/secrets'; export const addSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ method: 'POST', @@ -29,17 +34,20 @@ export const addSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ return response.badRequest({ body: { message, attributes: { details, ...payload } } }); } - const newMonitor: SavedObject = - await savedObjectsClient.create(syntheticsMonitorType, { - ...monitor, - revision: 1, - }); + const newMonitor: SavedObject = + await savedObjectsClient.create( + syntheticsMonitorType, + formatSecrets({ + ...monitor, + revision: 1, + }) + ); const { syntheticsService } = server; const errors = await syntheticsService.pushConfigs(request, [ { - ...newMonitor.attributes, + ...monitor, id: newMonitor.id, fields: { config_id: newMonitor.id, diff --git a/x-pack/plugins/uptime/server/rest_api/synthetics_service/delete_monitor.ts b/x-pack/plugins/uptime/server/rest_api/synthetics_service/delete_monitor.ts index 6d744a7a1a406d..6e94e1a8028974 100644 --- a/x-pack/plugins/uptime/server/rest_api/synthetics_service/delete_monitor.ts +++ b/x-pack/plugins/uptime/server/rest_api/synthetics_service/delete_monitor.ts @@ -6,15 +6,22 @@ */ import { schema } from '@kbn/config-schema'; import { SavedObjectsErrorHelpers } from '../../../../../../src/core/server'; -import { SyntheticsMonitor } from '../../../common/runtime_types'; +import { + EncryptedSyntheticsMonitor, + SyntheticsMonitorWithSecrets, +} from '../../../common/runtime_types'; import { UMRestApiRouteFactory } from '../types'; import { API_URLS } from '../../../common/constants'; -import { syntheticsMonitorType } from '../../lib/saved_objects/synthetics_monitor'; +import { + syntheticsMonitorType, + syntheticsMonitor, +} from '../../lib/saved_objects/synthetics_monitor'; import { getMonitorNotFoundResponse } from './service_errors'; import { sendTelemetryEvents, formatTelemetryDeleteEvent, } from './telemetry/monitor_upgrade_sender'; +import { normalizeSecrets } from '../../lib/synthetics_service/utils/secrets'; export const deleteSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ method: 'DELETE', @@ -24,26 +31,42 @@ export const deleteSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ monitorId: schema.string({ minLength: 1, maxLength: 1024 }), }), }, - handler: async ({ request, response, savedObjectsClient, server }): Promise => { - const { monitorId } = request.params; + handler: async ({ + request, + response, + savedObjectsClient, + server: { encryptedSavedObjects, syntheticsService, logger, telemetry, kibanaVersion }, + }): Promise => { + const encryptedSavedObjectsClient = encryptedSavedObjects.getClient(); - const { syntheticsService } = server; + const { monitorId } = request.params; try { - const monitor = await savedObjectsClient.get( + const encryptedMonitor = await savedObjectsClient.get( syntheticsMonitorType, monitorId ); + const monitor = + await encryptedSavedObjectsClient.getDecryptedAsInternalUser( + syntheticsMonitor.name, + monitorId, + { + namespace: encryptedMonitor.namespaces?.[0], + } + ); + + const normalizedMonitor = normalizeSecrets(monitor); + await savedObjectsClient.delete(syntheticsMonitorType, monitorId); const errors = await syntheticsService.deleteConfigs(request, [ - { ...monitor.attributes, id: monitorId }, + { ...normalizedMonitor.attributes, id: monitorId }, ]); sendTelemetryEvents( - server.logger, - server.telemetry, - formatTelemetryDeleteEvent(monitor, server.kibanaVersion, new Date().toISOString(), errors) + logger, + telemetry, + formatTelemetryDeleteEvent(monitor, kibanaVersion, new Date().toISOString(), errors) ); if (errors && errors.length > 0) { diff --git a/x-pack/plugins/uptime/server/rest_api/synthetics_service/edit_monitor.ts b/x-pack/plugins/uptime/server/rest_api/synthetics_service/edit_monitor.ts index 6170bdd72ac369..f590c45166fd58 100644 --- a/x-pack/plugins/uptime/server/rest_api/synthetics_service/edit_monitor.ts +++ b/x-pack/plugins/uptime/server/rest_api/synthetics_service/edit_monitor.ts @@ -8,16 +8,26 @@ import { schema } from '@kbn/config-schema'; import { SavedObjectsUpdateResponse, SavedObject } from 'kibana/server'; import { SavedObjectsErrorHelpers } from '../../../../../../src/core/server'; -import { MonitorFields, SyntheticsMonitor, ConfigKey } from '../../../common/runtime_types'; +import { + MonitorFields, + EncryptedSyntheticsMonitor, + SyntheticsMonitorWithSecrets, + SyntheticsMonitor, + ConfigKey, +} from '../../../common/runtime_types'; import { UMRestApiRouteFactory } from '../types'; import { API_URLS } from '../../../common/constants'; -import { syntheticsMonitorType } from '../../lib/saved_objects/synthetics_monitor'; +import { + syntheticsMonitorType, + syntheticsMonitor, +} from '../../lib/saved_objects/synthetics_monitor'; import { validateMonitor } from './monitor_validation'; import { getMonitorNotFoundResponse } from './service_errors'; import { sendTelemetryEvents, formatTelemetryUpdateEvent, } from './telemetry/monitor_upgrade_sender'; +import { formatSecrets, normalizeSecrets } from '../../lib/synthetics_service/utils/secrets'; // Simplify return promise type and type it with runtime_types export const editSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ @@ -29,31 +39,52 @@ export const editSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ }), body: schema.any(), }, - handler: async ({ request, response, savedObjectsClient, server }): Promise => { + handler: async ({ + request, + response, + savedObjectsClient, + server: { encryptedSavedObjects, syntheticsService, logger, telemetry, kibanaVersion }, + }): Promise => { + const encryptedSavedObjectsClient = encryptedSavedObjects.getClient(); const monitor = request.body as SyntheticsMonitor; - - const validationResult = validateMonitor(monitor as MonitorFields); - - if (!validationResult.valid) { - const { reason: message, details, payload } = validationResult; - return response.badRequest({ body: { message, attributes: { details, ...payload } } }); - } - const { monitorId } = request.params; - const { syntheticsService } = server; - try { - const previousMonitor: SavedObject = await savedObjectsClient.get( + const previousMonitor: SavedObject = await savedObjectsClient.get( syntheticsMonitorType, monitorId ); - const monitorWithRevision = { + + /* Decrypting the previous monitor before editing ensures that all existing fields remain + * on the object, even in flows where decryption does not take place, such as the enabled tab + * on the monitor list table. We do not decrypt monitors in bulk for the monitor list table */ + const decryptedPreviousMonitor = + await encryptedSavedObjectsClient.getDecryptedAsInternalUser( + syntheticsMonitor.name, + monitorId, + { + namespace: previousMonitor.namespaces?.[0], + } + ); + + const editedMonitor = { + ...normalizeSecrets(decryptedPreviousMonitor).attributes, ...monitor, - revision: (previousMonitor.attributes[ConfigKey.REVISION] || 0) + 1, }; - const editMonitor: SavedObjectsUpdateResponse = + const validationResult = validateMonitor(editedMonitor as MonitorFields); + + if (!validationResult.valid) { + const { reason: message, details, payload } = validationResult; + return response.badRequest({ body: { message, attributes: { details, ...payload } } }); + } + + const monitorWithRevision = formatSecrets({ + ...editedMonitor, + revision: (previousMonitor.attributes[ConfigKey.REVISION] || 0) + 1, + }); + + const editMonitor: SavedObjectsUpdateResponse = await savedObjectsClient.update( syntheticsMonitorType, monitorId, @@ -62,7 +93,7 @@ export const editSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ const errors = await syntheticsService.pushConfigs(request, [ { - ...(editMonitor.attributes as SyntheticsMonitor), + ...editedMonitor, id: editMonitor.id, fields: { config_id: editMonitor.id, @@ -72,9 +103,9 @@ export const editSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ ]); sendTelemetryEvents( - server.logger, - server.telemetry, - formatTelemetryUpdateEvent(editMonitor, previousMonitor, server.kibanaVersion, errors) + logger, + telemetry, + formatTelemetryUpdateEvent(editMonitor, previousMonitor, kibanaVersion, errors) ); // Return service sync errors in OK response @@ -89,6 +120,7 @@ export const editSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ if (SavedObjectsErrorHelpers.isNotFoundError(updateErr)) { return getMonitorNotFoundResponse(response, monitorId); } + logger.error(updateErr); throw updateErr; } diff --git a/x-pack/plugins/uptime/server/rest_api/synthetics_service/get_monitor.ts b/x-pack/plugins/uptime/server/rest_api/synthetics_service/get_monitor.ts index 5b7052ffa061d7..e32497b4dbc806 100644 --- a/x-pack/plugins/uptime/server/rest_api/synthetics_service/get_monitor.ts +++ b/x-pack/plugins/uptime/server/rest_api/synthetics_service/get_monitor.ts @@ -12,6 +12,7 @@ import { UMRestApiRouteFactory } from '../types'; import { API_URLS } from '../../../common/constants'; import { syntheticsMonitorType } from '../../lib/saved_objects/synthetics_monitor'; import { getMonitorNotFoundResponse } from './service_errors'; +import { normalizeSecrets } from '../../lib/synthetics_service/utils/secrets'; export const getSyntheticsMonitorRoute: UMRestApiRouteFactory = (libs: UMServerLibs) => ({ method: 'GET', @@ -21,10 +22,21 @@ export const getSyntheticsMonitorRoute: UMRestApiRouteFactory = (libs: UMServerL monitorId: schema.string({ minLength: 1, maxLength: 1024 }), }), }, - handler: async ({ request, response, savedObjectsClient }): Promise => { + handler: async ({ + request, + response, + server: { encryptedSavedObjects }, + savedObjectsClient, + }): Promise => { const { monitorId } = request.params; + const encryptedSavedObjectsClient = encryptedSavedObjects.getClient(); try { - return await libs.requests.getSyntheticsMonitor({ monitorId, savedObjectsClient }); + const monitorWithSecrets = await libs.requests.getSyntheticsMonitor({ + monitorId, + encryptedSavedObjectsClient, + savedObjectsClient, + }); + return normalizeSecrets(monitorWithSecrets); } catch (getErr) { if (SavedObjectsErrorHelpers.isNotFoundError(getErr)) { return getMonitorNotFoundResponse(response, monitorId); diff --git a/x-pack/plugins/uptime/server/rest_api/synthetics_service/telemetry/monitor_upgrade_sender.ts b/x-pack/plugins/uptime/server/rest_api/synthetics_service/telemetry/monitor_upgrade_sender.ts index d4ac7c85c9586e..2fe8d9eba761cc 100644 --- a/x-pack/plugins/uptime/server/rest_api/synthetics_service/telemetry/monitor_upgrade_sender.ts +++ b/x-pack/plugins/uptime/server/rest_api/synthetics_service/telemetry/monitor_upgrade_sender.ts @@ -9,7 +9,7 @@ import type { Logger } from 'src/core/server'; import { SavedObjectsUpdateResponse, SavedObject } from 'kibana/server'; import { MonitorFields, - SyntheticsMonitor, + EncryptedSyntheticsMonitor, ConfigKey, ServiceLocationErrors, } from '../../../../common/runtime_types'; @@ -48,7 +48,7 @@ export function formatTelemetryEvent({ deletedAt, errors, }: { - monitor: SavedObject; + monitor: SavedObject; kibanaVersion: string; lastUpdatedAt?: string; durationSinceLastUpdated?: number; @@ -70,7 +70,7 @@ export function formatTelemetryEvent({ monitorNameLength: attributes[ConfigKey.NAME].length, monitorInterval: parseInt(attributes[ConfigKey.SCHEDULE].number, 10) * 60 * 1000, stackVersion: kibanaVersion, - scriptType: getScriptType(attributes as MonitorFields), + scriptType: getScriptType(attributes as Partial), errors: errors && errors?.length ? errors.map((e) => ({ @@ -88,8 +88,8 @@ export function formatTelemetryEvent({ } export function formatTelemetryUpdateEvent( - currentMonitor: SavedObjectsUpdateResponse, - previousMonitor: SavedObject, + currentMonitor: SavedObjectsUpdateResponse, + previousMonitor: SavedObject, kibanaVersion: string, errors?: ServiceLocationErrors ) { @@ -101,7 +101,7 @@ export function formatTelemetryUpdateEvent( } return formatTelemetryEvent({ - monitor: currentMonitor as SavedObject, + monitor: currentMonitor as SavedObject, kibanaVersion, durationSinceLastUpdated, lastUpdatedAt: previousMonitor.updated_at, @@ -110,7 +110,7 @@ export function formatTelemetryUpdateEvent( } export function formatTelemetryDeleteEvent( - previousMonitor: SavedObject, + previousMonitor: SavedObject, kibanaVersion: string, deletedAt: string, errors?: ServiceLocationErrors @@ -122,7 +122,7 @@ export function formatTelemetryDeleteEvent( } return formatTelemetryEvent({ - monitor: previousMonitor as SavedObject, + monitor: previousMonitor as SavedObject, kibanaVersion, durationSinceLastUpdated, lastUpdatedAt: previousMonitor.updated_at, @@ -131,12 +131,14 @@ export function formatTelemetryDeleteEvent( }); } -function getScriptType(attributes: MonitorFields): 'inline' | 'recorder' | 'zip' | undefined { +function getScriptType( + attributes: Partial +): 'inline' | 'recorder' | 'zip' | undefined { if (attributes[ConfigKey.SOURCE_ZIP_URL]) { return 'zip'; } else if ( attributes[ConfigKey.SOURCE_INLINE] && - attributes[ConfigKey.METADATA].script_source?.is_generated_script + attributes[ConfigKey.METADATA]?.script_source?.is_generated_script ) { return 'recorder'; } else if (attributes[ConfigKey.SOURCE_INLINE]) { diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/get_execution_log.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/get_execution_log.ts index 5b2ba00ace7f85..c7bb15ba12a981 100644 --- a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/get_execution_log.ts +++ b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/get_execution_log.ts @@ -69,6 +69,8 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo expect(response.status).to.eql(200); expect(response.body.total).to.eql(2); + expect(response.body.totalErrors).to.eql(0); + expect(response.body.errors).to.eql([]); const execLogs = response.body.data; expect(execLogs.length).to.eql(2); @@ -120,6 +122,8 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo expect(response.body.total).to.eql(0); expect(response.body.data).to.eql([]); + expect(response.body.totalErrors).to.eql(0); + expect(response.body.errors).to.eql([]); }); it('gets execution log for rule that performs ES searches', async () => { @@ -148,6 +152,8 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo expect(response.status).to.eql(200); expect(response.body.total).to.eql(1); + expect(response.body.totalErrors).to.eql(0); + expect(response.body.errors).to.eql([]); const execLogs = response.body.data; expect(execLogs.length).to.eql(1); @@ -202,6 +208,19 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo for (const log of execLogs) { expect(log.status).to.equal('failure'); expect(log.timed_out).to.equal(false); + expect(log.message).to.equal( + `rule execution failure: test.throw:${createdRule.id}: 'abc' - this alert is intended to fail` + ); + } + + expect(response.body.totalErrors).to.eql(1); + expect(response.body.errors.length).to.eql(1); + + for (const errors of response.body.errors) { + expect(errors.type).to.equal('alerting'); + expect(errors.message).to.equal( + `rule execution failure: test.throw:${createdRule.id}: 'abc' - this alert is intended to fail` + ); } }); @@ -238,6 +257,16 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo expect(log.status).to.equal('success'); expect(log.timed_out).to.equal(true); } + + expect(response.body.totalErrors).to.eql(1); + expect(response.body.errors.length).to.eql(1); + + for (const errors of response.body.errors) { + expect(errors.type).to.equal('alerting'); + expect(errors.message).to.equal( + `rule: test.patternLongRunning:${createdRule.id}: 'abc' execution cancelled due to timeout - exceeded rule type timeout of 3s` + ); + } }); it('gets execution log for rule that triggers actions', async () => { @@ -281,6 +310,8 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo expect(response.status).to.eql(200); expect(response.body.total).to.eql(1); + expect(response.body.totalErrors).to.eql(0); + expect(response.body.errors).to.eql([]); const execLogs = response.body.data; expect(execLogs.length).to.eql(1); @@ -352,6 +383,16 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo expect(log.num_succeeded_actions).to.equal(0); expect(log.num_errored_actions).to.equal(1); } + + expect(response.body.totalErrors).to.eql(1); + expect(response.body.errors.length).to.eql(1); + + for (const errors of response.body.errors) { + expect(errors.type).to.equal('actions'); + expect(errors.message).to.equal( + `action execution failure: test.throw:${createdConnector.id}: connector that throws - an error occurred while running the action executor: this action is intended to fail` + ); + } }); it('handles date_end if specified', async () => { @@ -376,6 +417,8 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo expect(response.body.total).to.eql(0); expect(response.body.data.length).to.eql(0); + expect(response.body.totalErrors).to.eql(0); + expect(response.body.errors.length).to.eql(0); }); it('handles sort query parameter', async () => { @@ -396,6 +439,8 @@ export default function createGetExecutionLogTests({ getService }: FtrProviderCo expect(response.status).to.eql(200); expect(response.body.total).to.eql(3); + expect(response.body.totalErrors).to.eql(0); + expect(response.body.errors).to.eql([]); const execLogs = response.body.data; expect(execLogs.length).to.eql(3); diff --git a/x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts b/x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts index b7c1fc6bc58528..54c8cbc6b07a94 100644 --- a/x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts +++ b/x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts @@ -4,7 +4,9 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ +import { omit } from 'lodash'; import expect from '@kbn/expect'; +import { secretKeys } from '../../../../../plugins/uptime/common/constants/monitor_management'; import { HTTPFields } from '../../../../../plugins/uptime/common/runtime_types'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { API_URLS } from '../../../../../plugins/uptime/common/constants'; @@ -33,7 +35,7 @@ export default function ({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'true') .send(newMonitor); - expect(apiResponse.body.attributes).eql(newMonitor); + expect(apiResponse.body.attributes).eql(omit(newMonitor, secretKeys)); }); it('returns bad request if payload is invalid for HTTP monitor', async () => { diff --git a/x-pack/test/api_integration/apis/uptime/rest/edit_monitor.ts b/x-pack/test/api_integration/apis/uptime/rest/edit_monitor.ts index c453d28259a2c0..4263d7aece8103 100644 --- a/x-pack/test/api_integration/apis/uptime/rest/edit_monitor.ts +++ b/x-pack/test/api_integration/apis/uptime/rest/edit_monitor.ts @@ -5,7 +5,9 @@ * 2.0. */ import expect from '@kbn/expect'; +import { omit } from 'lodash'; import { SimpleSavedObject } from 'kibana/public'; +import { secretKeys } from '../../../../../plugins/uptime/common/constants/monitor_management'; import { ConfigKey, HTTPFields, @@ -46,14 +48,14 @@ export default function ({ getService }: FtrProviderContext) { newMonitor as MonitorFields ); - expect(savedMonitor).eql(newMonitor); + expect(savedMonitor).eql(omit(newMonitor, secretKeys)); const updates: Partial = { [ConfigKey.URLS]: 'https://modified-host.com', [ConfigKey.NAME]: 'Modified name', }; - const modifiedMonitor = { ...savedMonitor, ...updates, revision: 2 }; + const modifiedMonitor = { ...newMonitor, ...updates }; const editResponse = await supertest .put(API_URLS.SYNTHETICS_MONITORS + '/' + monitorId) @@ -61,7 +63,9 @@ export default function ({ getService }: FtrProviderContext) { .send(modifiedMonitor) .expect(200); - expect(editResponse.body.attributes).eql(modifiedMonitor); + expect(editResponse.body.attributes).eql( + omit({ ...modifiedMonitor, revision: 2 }, secretKeys) + ); }); it('returns 404 if monitor id is not present', async () => { @@ -83,7 +87,7 @@ export default function ({ getService }: FtrProviderContext) { ); // Delete a required property to make payload invalid - const toUpdate = { ...savedMonitor, 'check.request.headers': undefined }; + const toUpdate = { ...savedMonitor, 'check.request.headers': null }; const apiResponse = await supertest .put(API_URLS.SYNTHETICS_MONITORS + '/' + monitorId) diff --git a/x-pack/test/api_integration/apis/uptime/rest/get_monitor.ts b/x-pack/test/api_integration/apis/uptime/rest/get_monitor.ts index 37339cc0e05949..b24a83769caa98 100644 --- a/x-pack/test/api_integration/apis/uptime/rest/get_monitor.ts +++ b/x-pack/test/api_integration/apis/uptime/rest/get_monitor.ts @@ -10,6 +10,7 @@ import { SimpleSavedObject } from 'kibana/public'; import { MonitorFields } from '../../../../../plugins/uptime/common/runtime_types'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { API_URLS } from '../../../../../plugins/uptime/common/constants'; +import { formatSecrets } from '../../../../../plugins/uptime/server/lib/synthetics_service/utils/secrets'; import { getFixtureJson } from './helper/get_fixture_json'; export default function ({ getService }: FtrProviderContext) { @@ -85,13 +86,17 @@ export default function ({ getService }: FtrProviderContext) { describe('get one monitor', () => { it('should get by id', async () => { - const [{ id: id1, attributes: mon1 }] = await Promise.all(monitors.map(saveMonitor)); + const [{ id: id1 }] = await Promise.all(monitors.map(saveMonitor)); const apiResponse = await supertest .get(API_URLS.SYNTHETICS_MONITORS + '/' + id1) .expect(200); - expect(apiResponse.body.attributes).eql(mon1); + expect(apiResponse.body.attributes).eql({ + ...monitors[0], + revision: 1, + secrets: formatSecrets(monitors[0]).secrets, + }); }); it('returns 404 if monitor id is not found', async () => { diff --git a/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/get_rule_execution_events.ts b/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/get_rule_execution_events.ts new file mode 100644 index 00000000000000..555c16e206ab84 --- /dev/null +++ b/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/get_rule_execution_events.ts @@ -0,0 +1,227 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import dateMath from '@elastic/datemath'; +import expect from '@kbn/expect'; +import moment from 'moment'; +import { set } from '@elastic/safer-lodash-set'; +import uuid from 'uuid'; +import { detectionEngineRuleExecutionEventsUrl } from '../../../../plugins/security_solution/common/constants'; +import { RuleExecutionStatus } from '../../../../plugins/security_solution/common/detection_engine/schemas/common'; + +import { FtrProviderContext } from '../../common/ftr_provider_context'; +import { + createRule, + createSignalsIndex, + deleteAllAlerts, + deleteAllEventLogExecutionEvents, + deleteSignalsIndex, + getRuleForSignalTesting, + indexEventLogExecutionEvents, + waitForEventLogExecuteComplete, + waitForRuleSuccessOrStatus, +} from '../../utils'; +import { failedGapExecution } from './template_data/execution_events'; + +// eslint-disable-next-line import/no-default-export +export default ({ getService }: FtrProviderContext) => { + const supertest = getService('supertest'); + const esArchiver = getService('esArchiver'); + const es = getService('es'); + const log = getService('log'); + + describe('Get Rule Execution Log Events', () => { + before(async () => { + await esArchiver.load('x-pack/test/functional/es_archives/auditbeat/hosts'); + await esArchiver.load('x-pack/test/functional/es_archives/security_solution/alias'); + await createSignalsIndex(supertest, log); + }); + + after(async () => { + await esArchiver.unload('x-pack/test/functional/es_archives/auditbeat/hosts'); + await esArchiver.unload('x-pack/test/functional/es_archives/security_solution/alias'); + await deleteSignalsIndex(supertest, log); + }); + + beforeEach(async () => { + await deleteAllAlerts(supertest, log); + await deleteAllEventLogExecutionEvents(es, log); + }); + + afterEach(async () => { + await deleteAllAlerts(supertest, log); + await deleteAllEventLogExecutionEvents(es, log); + }); + + it('should return an error if rule does not exist', async () => { + const start = dateMath.parse('now-24h')?.utc().toISOString(); + const end = dateMath.parse('now', { roundUp: true })?.utc().toISOString(); + const response = await supertest + .get(detectionEngineRuleExecutionEventsUrl('1')) + .set('kbn-xsrf', 'true') + .query({ start, end }); + + expect(response.status).to.eql(404); + expect(response.text).to.eql( + '{"message":"Saved object [alert/1] not found","status_code":404}' + ); + }); + + it('should return execution events for a rule that has executed successfully', async () => { + const rule = getRuleForSignalTesting(['auditbeat-*']); + const { id } = await createRule(supertest, log, rule); + await waitForRuleSuccessOrStatus(supertest, log, id); + await waitForEventLogExecuteComplete(es, log, id); + + const start = dateMath.parse('now-24h')?.utc().toISOString(); + const end = dateMath.parse('now', { roundUp: true })?.utc().toISOString(); + const response = await supertest + .get(detectionEngineRuleExecutionEventsUrl(id)) + .set('kbn-xsrf', 'true') + .query({ start, end }); + + expect(response.status).to.eql(200); + expect(response.body.total).to.eql(1); + expect(response.body.events[0].duration_ms).to.greaterThan(0); + expect(response.body.events[0].search_duration_ms).to.greaterThan(0); + expect(response.body.events[0].schedule_delay_ms).to.greaterThan(0); + expect(response.body.events[0].indexing_duration_ms).to.greaterThan(0); + expect(response.body.events[0].gap_duration_ms).to.eql(0); + expect(response.body.events[0].security_status).to.eql('succeeded'); + expect(response.body.events[0].security_message).to.eql('succeeded'); + }); + + it('should return execution events for a rule that has executed in a warning state', async () => { + const rule = getRuleForSignalTesting(['auditbeat-*', 'no-name-index']); + const { id } = await createRule(supertest, log, rule); + await waitForRuleSuccessOrStatus(supertest, log, id, RuleExecutionStatus['partial failure']); + await waitForEventLogExecuteComplete(es, log, id); + + const start = dateMath.parse('now-24h')?.utc().toISOString(); + const end = dateMath.parse('now', { roundUp: true })?.utc().toISOString(); + const response = await supertest + .get(detectionEngineRuleExecutionEventsUrl(id)) + .set('kbn-xsrf', 'true') + .query({ start, end }); + + expect(response.status).to.eql(200); + expect(response.body.total).to.eql(1); + expect(response.body.events[0].duration_ms).to.greaterThan(0); + expect(response.body.events[0].search_duration_ms).to.eql(0); + expect(response.body.events[0].schedule_delay_ms).to.greaterThan(0); + expect(response.body.events[0].indexing_duration_ms).to.eql(0); + expect(response.body.events[0].gap_duration_ms).to.eql(0); + expect(response.body.events[0].security_status).to.eql('partial failure'); + expect( + response.body.events[0].security_message.startsWith( + 'Check privileges failed to execute ResponseError: index_not_found_exception: [index_not_found_exception] Reason: no such index [no-name-index]' + ) + ).to.eql(true); + }); + + // TODO: Debug indexing + it.skip('should return execution events for a rule that has executed in a failure state with a gap', async () => { + const rule = getRuleForSignalTesting(['auditbeat-*'], uuid.v4(), false); + const { id } = await createRule(supertest, log, rule); + + const start = dateMath.parse('now')?.utc().toISOString(); + const end = dateMath.parse('now+24h', { roundUp: true })?.utc().toISOString(); + + // Create 5 timestamps a minute apart to use in the templated data + const dateTimes = [...Array(5).keys()].map((i) => + moment(start) + .add(i + 1, 'm') + .toDate() + .toISOString() + ); + + const events = failedGapExecution.map((e, i) => { + set(e, '@timestamp', dateTimes[i]); + set(e, 'event.start', dateTimes[i]); + set(e, 'event.end', dateTimes[i]); + set(e, 'rule.id', id); + return e; + }); + + await indexEventLogExecutionEvents(es, log, events); + await waitForEventLogExecuteComplete(es, log, id); + + const response = await supertest + .get(detectionEngineRuleExecutionEventsUrl(id)) + .set('kbn-xsrf', 'true') + .query({ start, end }); + + // console.log(JSON.stringify(response)); + + expect(response.status).to.eql(200); + expect(response.body.total).to.eql(1); + expect(response.body.events[0].duration_ms).to.eql(4236); + expect(response.body.events[0].search_duration_ms).to.eql(0); + expect(response.body.events[0].schedule_delay_ms).to.greaterThan(0); + expect(response.body.events[0].indexing_duration_ms).to.eql(0); + expect(response.body.events[0].gap_duration_ms).to.greaterThan(0); + expect(response.body.events[0].security_status).to.eql('failed'); + expect( + response.body.events[0].security_message.startsWith( + 'Check privileges failed to execute ResponseError: index_not_found_exception: [index_not_found_exception] Reason: no such index [no-name-index]' + ) + ).to.eql(true); + }); + + // it('should return execution events when providing a status filter', async () => { + // const rule = getRuleForSignalTesting(['auditbeat-*', 'no-name-index']); + // const { id } = await createRule(supertest, log, rule); + // await waitForRuleSuccessOrStatus(supertest, log, id, RuleExecutionStatus.failed); + // await waitForSignalsToBePresent(supertest, log, 1, [id]); + // + // const start = dateMath.parse('now-24h')?.utc().toISOString(); + // const end = dateMath.parse('now', { roundUp: true })?.utc().toISOString(); + // const response = await supertest + // .get(detectionEngineRuleExecutionEventsUrl(id)) + // .set('kbn-xsrf', 'true') + // .query({ start, end }); + // + // expect(response.status).to.eql(200); + // expect(response.body.total).to.eql(1); + // expect(response.body.events[0].duration_ms).to.greaterThan(0); + // expect(response.body.events[0].search_duration_ms).to.eql(0); + // expect(response.body.events[0].schedule_delay_ms).to.greaterThan(0); + // expect(response.body.events[0].indexing_duration_ms).to.eql(0); + // expect(response.body.events[0].gap_duration_ms).to.eql(0); + // expect(response.body.events[0].security_status).to.eql('failed'); + // expect(response.body.events[0].security_message).to.include( + // 'were not queried between this rule execution and the last execution, so signals may have been missed. ' + // ); + // }); + + // it('should return execution events when providing a status filter and sortField', async () => { + // const rule = getRuleForSignalTesting(['auditbeat-*', 'no-name-index']); + // const { id } = await createRule(supertest, log, rule); + // await waitForRuleSuccessOrStatus(supertest, log, id, RuleExecutionStatus.failed); + // await waitForSignalsToBePresent(supertest, log, 1, [id]); + // + // const start = dateMath.parse('now-24h')?.utc().toISOString(); + // const end = dateMath.parse('now', { roundUp: true })?.utc().toISOString(); + // const response = await supertest + // .get(detectionEngineRuleExecutionEventsUrl(id)) + // .set('kbn-xsrf', 'true') + // .query({ start, end }); + // + // expect(response.status).to.eql(200); + // expect(response.body.total).to.eql(1); + // expect(response.body.events[0].duration_ms).to.greaterThan(0); + // expect(response.body.events[0].search_duration_ms).to.eql(0); + // expect(response.body.events[0].schedule_delay_ms).to.greaterThan(0); + // expect(response.body.events[0].indexing_duration_ms).to.eql(0); + // expect(response.body.events[0].gap_duration_ms).to.eql(0); + // expect(response.body.events[0].security_status).to.eql('failed'); + // expect(response.body.events[0].security_message).to.include( + // 'were not queried between this rule execution and the last execution, so signals may have been missed. ' + // ); + // }); + }); +}; diff --git a/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/index.ts b/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/index.ts index a9bda196380418..dbe24c77b57ae9 100644 --- a/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/index.ts +++ b/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/index.ts @@ -32,6 +32,7 @@ export default ({ loadTestFile }: FtrProviderContext): void => { loadTestFile(require.resolve('./find_rules')); loadTestFile(require.resolve('./generating_signals')); loadTestFile(require.resolve('./get_prepackaged_rules_status')); + loadTestFile(require.resolve('./get_rule_execution_events')); loadTestFile(require.resolve('./import_rules')); loadTestFile(require.resolve('./import_export_rules')); loadTestFile(require.resolve('./read_rules')); diff --git a/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/template_data/execution_events.ts b/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/template_data/execution_events.ts new file mode 100644 index 00000000000000..c4767bbcc5632a --- /dev/null +++ b/x-pack/test/detection_engine_api_integration/security_and_spaces/tests/template_data/execution_events.ts @@ -0,0 +1,630 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const successfulExecution = [ + { + '@timestamp': '2022-03-17T22:59:31.360Z', + event: { + provider: 'alerting', + action: 'execute', + kind: 'alert', + category: ['siem'], + start: '2022-03-17T22:59:28.100Z', + outcome: 'success', + end: '2022-03-17T22:59:31.283Z', + duration: 3183000000, + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '7e62d859-aeaa-4e3d-8b9c-b3b737356383', + metrics: { + number_of_triggered_actions: 0, + number_of_searches: 2, + es_search_duration_ms: 1, + total_search_duration_ms: 15, + }, + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + type_id: 'siem.queryRule', + }, + ], + task: { + scheduled: '2022-03-17T22:59:25.051Z', + schedule_delay: 3049000000, + }, + alerting: { + status: 'ok', + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + license: 'basic', + category: 'siem.queryRule', + ruleset: 'siem', + name: 'Lots of Execution Events', + }, + message: + "rule executed: siem.queryRule:fb1fc150-a292-11ec-a2cf-c1b28b0392b0: 'Lots of Execution Events'", + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-17T22:59:30.296Z', + event: { + provider: 'securitySolution.ruleExecution', + kind: 'metric', + action: 'execution-metrics', + sequence: 1, + }, + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + name: 'Lots of Execution Events', + category: 'siem.queryRule', + }, + kibana: { + alert: { + rule: { + execution: { + metrics: { + total_search_duration_ms: 12, + total_indexing_duration_ms: 0, + }, + uuid: '7e62d859-aeaa-4e3d-8b9c-b3b737356383', + }, + }, + }, + space_ids: ['default'], + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + }, + ], + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-17T22:59:30.296Z', + event: { + provider: 'securitySolution.ruleExecution', + kind: 'event', + action: 'status-change', + sequence: 2, + }, + message: 'succeeded', + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + name: 'Lots of Execution Events', + category: 'siem.queryRule', + }, + kibana: { + alert: { + rule: { + execution: { + status: 'succeeded', + status_order: 0, + uuid: '7e62d859-aeaa-4e3d-8b9c-b3b737356383', + }, + }, + }, + space_ids: ['default'], + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + }, + ], + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-17T22:59:28.134Z', + event: { + provider: 'securitySolution.ruleExecution', + kind: 'event', + action: 'status-change', + sequence: 0, + }, + message: '', + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + name: 'Lots of Execution Events', + category: 'siem.queryRule', + }, + kibana: { + alert: { + rule: { + execution: { + status: 'running', + status_order: 15, + uuid: '7e62d859-aeaa-4e3d-8b9c-b3b737356383', + }, + }, + }, + space_ids: ['default'], + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + }, + ], + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-17T22:59:28.100Z', + event: { + provider: 'alerting', + action: 'execute-start', + kind: 'alert', + category: ['siem'], + start: '2022-03-17T22:59:28.100Z', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '7e62d859-aeaa-4e3d-8b9c-b3b737356383', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + type_id: 'siem.queryRule', + }, + ], + task: { + scheduled: '2022-03-17T22:59:25.051Z', + schedule_delay: 3049000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + license: 'basic', + category: 'siem.queryRule', + ruleset: 'siem', + }, + message: 'rule execution start: "fb1fc150-a292-11ec-a2cf-c1b28b0392b0"', + ecs: { + version: '1.8.0', + }, + }, +]; + +export const failedGapExecution = [ + { + '@timestamp': '2022-03-17T12:36:16.413Z', + event: { + provider: 'alerting', + action: 'execute', + kind: 'alert', + category: ['siem'], + start: '2022-03-17T12:36:14.868Z', + outcome: 'success', + end: '2022-03-17T12:36:16.413Z', + duration: 1545000000, + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '38fa2d4a-94d3-4ea3-80d6-d1284eb98357', + metrics: { + number_of_triggered_actions: 0, + number_of_searches: 6, + es_search_duration_ms: 2, + total_search_duration_ms: 15, + }, + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + type_id: 'siem.queryRule', + }, + ], + task: { + scheduled: '2022-03-17T12:27:10.060Z', + schedule_delay: 544808000000, + }, + alerting: { + status: 'ok', + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + license: 'basic', + category: 'siem.queryRule', + ruleset: 'siem', + name: 'Lots of Execution Events', + }, + message: + "rule executed: siem.queryRule:fb1fc150-a292-11ec-a2cf-c1b28b0392b0: 'Lots of Execution Events'", + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-17T12:36:15.382Z', + event: { + provider: 'securitySolution.ruleExecution', + kind: 'metric', + action: 'execution-metrics', + sequence: 1, + }, + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + name: 'Lots of Execution Events', + category: 'siem.queryRule', + }, + kibana: { + alert: { + rule: { + execution: { + metrics: { + execution_gap_duration_s: 245, + }, + uuid: '38fa2d4a-94d3-4ea3-80d6-d1284eb98357', + }, + }, + }, + space_ids: ['default'], + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + }, + ], + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-17T12:36:15.382Z', + event: { + provider: 'securitySolution.ruleExecution', + kind: 'event', + action: 'status-change', + sequence: 2, + }, + message: + '4 minutes (244689ms) were not queried between this rule execution and the last execution, so signals may have been missed. Consider increasing your look behind time or adding more Kibana instances. name: "Lots of Execution Events" id: "fb1fc150-a292-11ec-a2cf-c1b28b0392b0" rule id: "7c44befd-f611-4994-b116-9861df75d0cb" execution id: "38fa2d4a-94d3-4ea3-80d6-d1284eb98357" space ID: "default"', + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + name: 'Lots of Execution Events', + category: 'siem.queryRule', + }, + kibana: { + alert: { + rule: { + execution: { + status: 'failed', + status_order: 30, + uuid: '38fa2d4a-94d3-4ea3-80d6-d1284eb98357', + }, + }, + }, + space_ids: ['default'], + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + }, + ], + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-17T12:36:14.888Z', + event: { + provider: 'securitySolution.ruleExecution', + kind: 'event', + action: 'status-change', + sequence: 0, + }, + message: '', + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + name: 'Lots of Execution Events', + category: 'siem.queryRule', + }, + kibana: { + alert: { + rule: { + execution: { + status: 'running', + status_order: 15, + uuid: '38fa2d4a-94d3-4ea3-80d6-d1284eb98357', + }, + }, + }, + space_ids: ['default'], + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + }, + ], + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-17T12:36:14.868Z', + event: { + provider: 'alerting', + action: 'execute-start', + kind: 'alert', + category: ['siem'], + start: '2022-03-17T12:36:14.868Z', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: '38fa2d4a-94d3-4ea3-80d6-d1284eb98357', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + type_id: 'siem.queryRule', + }, + ], + task: { + scheduled: '2022-03-17T12:27:10.060Z', + schedule_delay: 544808000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + rule: { + id: 'fb1fc150-a292-11ec-a2cf-c1b28b0392b0', + license: 'basic', + category: 'siem.queryRule', + ruleset: 'siem', + }, + message: 'rule execution start: "fb1fc150-a292-11ec-a2cf-c1b28b0392b0"', + ecs: { + version: '1.8.0', + }, + }, +]; + +export const partialWarningExecution = [ + { + '@timestamp': '2022-03-16T23:28:36.012Z', + event: { + provider: 'alerting', + action: 'execute', + kind: 'alert', + category: ['siem'], + start: '2022-03-16T23:28:34.365Z', + outcome: 'success', + end: '2022-03-16T23:28:36.012Z', + duration: 1647000000, + }, + kibana: { + alert: { + rule: { + execution: { + uuid: 'ce37a09d-9359-4756-abbf-e319dd6b1336', + metrics: { + number_of_triggered_actions: 0, + number_of_searches: 2, + es_search_duration_ms: 0, + total_search_duration_ms: 3, + }, + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'f78f3550-a186-11ec-89a1-0bce95157aba', + type_id: 'siem.queryRule', + }, + ], + task: { + scheduled: '2022-03-16T23:28:31.233Z', + schedule_delay: 3132000000, + }, + alerting: { + status: 'ok', + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + rule: { + id: 'f78f3550-a186-11ec-89a1-0bce95157aba', + license: 'basic', + category: 'siem.queryRule', + ruleset: 'siem', + name: 'This Rule Makes Alerts, Actions, AND Moar!', + }, + message: + "rule executed: siem.queryRule:f78f3550-a186-11ec-89a1-0bce95157aba: 'This Rule Makes Alerts, Actions, AND Moar!'", + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-16T23:28:34.998Z', + event: { + provider: 'securitySolution.ruleExecution', + kind: 'event', + action: 'status-change', + sequence: 1, + }, + message: + 'Check privileges failed to execute ResponseError: index_not_found_exception: [index_not_found_exception] Reason: no such index [frank] name: "This Rule Makes Alerts, Actions, AND Moar!" id: "f78f3550-a186-11ec-89a1-0bce95157aba" rule id: "b64b4540-d035-4826-a1e7-f505bf4b9653" execution id: "ce37a09d-9359-4756-abbf-e319dd6b1336" space ID: "default"', + rule: { + id: 'f78f3550-a186-11ec-89a1-0bce95157aba', + name: 'This Rule Makes Alerts, Actions, AND Moar!', + category: 'siem.queryRule', + }, + kibana: { + alert: { + rule: { + execution: { + status: 'partial failure', + status_order: 20, + uuid: 'ce37a09d-9359-4756-abbf-e319dd6b1336', + }, + }, + }, + space_ids: ['default'], + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'f78f3550-a186-11ec-89a1-0bce95157aba', + }, + ], + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-16T23:28:34.386Z', + event: { + provider: 'securitySolution.ruleExecution', + kind: 'event', + action: 'status-change', + sequence: 0, + }, + message: '', + rule: { + id: 'f78f3550-a186-11ec-89a1-0bce95157aba', + name: 'This Rule Makes Alerts, Actions, AND Moar!', + category: 'siem.queryRule', + }, + kibana: { + alert: { + rule: { + execution: { + status: 'running', + status_order: 15, + uuid: 'ce37a09d-9359-4756-abbf-e319dd6b1336', + }, + }, + }, + space_ids: ['default'], + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'f78f3550-a186-11ec-89a1-0bce95157aba', + }, + ], + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + ecs: { + version: '1.8.0', + }, + }, + { + '@timestamp': '2022-03-16T23:28:34.365Z', + event: { + provider: 'alerting', + action: 'execute-start', + kind: 'alert', + category: ['siem'], + start: '2022-03-16T23:28:34.365Z', + }, + kibana: { + alert: { + rule: { + execution: { + uuid: 'ce37a09d-9359-4756-abbf-e319dd6b1336', + }, + }, + }, + saved_objects: [ + { + rel: 'primary', + type: 'alert', + id: 'f78f3550-a186-11ec-89a1-0bce95157aba', + type_id: 'siem.queryRule', + }, + ], + task: { + scheduled: '2022-03-16T23:28:31.233Z', + schedule_delay: 3132000000, + }, + server_uuid: '5b2de169-2785-441b-ae8c-186a1936b17d', + version: '8.2.0', + }, + rule: { + id: 'f78f3550-a186-11ec-89a1-0bce95157aba', + license: 'basic', + category: 'siem.queryRule', + ruleset: 'siem', + }, + message: 'rule execution start: "f78f3550-a186-11ec-89a1-0bce95157aba"', + ecs: { + version: '1.8.0', + }, + }, +]; diff --git a/x-pack/test/detection_engine_api_integration/utils.ts b/x-pack/test/detection_engine_api_integration/utils.ts index 545bd20fc777b1..594f380199dd69 100644 --- a/x-pack/test/detection_engine_api_integration/utils.ts +++ b/x-pack/test/detection_engine_api_integration/utils.ts @@ -5,6 +5,7 @@ * 2.0. */ +import { SearchTotalHits } from '@elastic/elasticsearch/lib/api/types'; import { KbnClient } from '@kbn/test'; import { ALERT_RULE_RULE_ID, ALERT_RULE_UUID } from '@kbn/rule-data-utils'; @@ -1466,6 +1467,124 @@ export const waitForSignalsToBePresent = async ( ); }; +/** + * Waits for the event-log execution completed doc count to be greater than the + * supplied number before continuing with a default of at least one execution + * @param es The ES client + * @param log + * @param ruleId The id of rule to check execution logs for + * @param totalExecutions The number of executions to wait for, default is 1 + */ +export const waitForEventLogExecuteComplete = async ( + es: Client, + log: ToolingLog, + ruleId: string, + totalExecutions = 1 +): Promise => { + await waitFor( + async () => { + const executionCount = await getEventLogExecuteCompleteById(es, log, ruleId); + return executionCount >= totalExecutions; + }, + 'waitForEventLogExecuteComplete', + log + ); +}; + +/** + * Given a single rule id this will return the number of event-log execution + * completed docs + * @param es The ES client + * @param log + * @param ruleId Rule id + */ +export const getEventLogExecuteCompleteById = async ( + es: Client, + log: ToolingLog, + ruleId: string +): Promise => { + const response = await es.search({ + index: '.kibana-event-log*', + track_total_hits: true, + size: 0, + query: { + bool: { + must: [], + filter: [ + { + match_phrase: { + 'event.provider': 'alerting', + }, + }, + { + match_phrase: { + 'event.action': 'execute', + }, + }, + { + match_phrase: { + 'rule.id': ruleId, + }, + }, + ], + should: [], + must_not: [], + }, + }, + }); + + return (response?.hits?.total as SearchTotalHits)?.value ?? 0; +}; + +/** + * Indexes provided execution events into .kibana-event-log-* + * @param es The ElasticSearch handle + * @param log The tooling logger + * @param events + */ +export const indexEventLogExecutionEvents = async ( + es: Client, + log: ToolingLog, + events: object[] +): Promise => { + const operations = events.flatMap((doc: object) => [ + { index: { _index: '.kibana-event-log-*' } }, + doc, + ]); + + await es.bulk({ refresh: true, operations }); + + return; +}; + +/** + * Remove all .kibana-event-log-* documents with an execution.uuid + * This will retry 20 times before giving up and hopefully still not interfere with other tests + * @param es The ElasticSearch handle + * @param log The tooling logger + */ +export const deleteAllEventLogExecutionEvents = async ( + es: Client, + log: ToolingLog +): Promise => { + return countDownES( + async () => { + return es.deleteByQuery( + { + index: '.kibana-event-log-*', + q: '_exists_:kibana.alert.rule.execution.uuid', + wait_for_completion: true, + refresh: true, + body: {}, + }, + { meta: true } + ); + }, + 'deleteAllEventLogExecutionEvents', + log + ); +}; + /** * Returns all signals both closed and opened by ruleId * @param supertest Deps diff --git a/x-pack/test/functional/apps/discover/value_suggestions.ts b/x-pack/test/functional/apps/discover/value_suggestions.ts index e67d42bf278967..34fbebbba5b55b 100644 --- a/x-pack/test/functional/apps/discover/value_suggestions.ts +++ b/x-pack/test/functional/apps/discover/value_suggestions.ts @@ -68,6 +68,12 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await queryBar.setQuery('extension.raw : '); await queryBar.expectSuggestions({ count: 5, contains: '"jpg"' }); }); + + it('also displays descriptions for operators', async () => { + await PageObjects.timePicker.setDefaultAbsoluteRange(); + await queryBar.setQuery('extension.raw'); + await queryBar.expectSuggestionsDescription({ count: 2 }); + }); }); describe('context', () => { diff --git a/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/details.ts b/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/details.ts index 74595e812f42aa..22c98b189a590b 100644 --- a/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/details.ts +++ b/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/details.ts @@ -9,6 +9,7 @@ import expect from '@kbn/expect'; import uuid from 'uuid'; import { omit, mapValues, range, flatten } from 'lodash'; import moment from 'moment'; +import { asyncForEach } from '@kbn/std'; import { FtrProviderContext } from '../../ftr_provider_context'; import { ObjectRemover } from '../../lib/object_remover'; import { alwaysFiringAlertType } from '../../fixtures/plugins/alerts/server/plugin'; @@ -74,7 +75,8 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { async function createRuleWithActionsAndParams( testRunUuid: string, - params: Record = {} + params: Record = {}, + overwrites: Record = {} ) { const connectors = await createConnectors(testRunUuid); return await createAlwaysFiringRule({ @@ -88,6 +90,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }, })), params, + ...overwrites, }); } @@ -581,6 +584,9 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { // Get action groups const { actionGroups } = alwaysFiringAlertType; + // If the tab exists, click on the alert list + await pageObjects.triggersActionsUI.maybeClickOnAlertTab(); + // Verify content await testSubjects.existOrFail('alertsList'); @@ -679,6 +685,9 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { // refresh to see rule await browser.refresh(); + // If the tab exists, click on the alert list + await pageObjects.triggersActionsUI.maybeClickOnAlertTab(); + const alertsList: any[] = await pageObjects.ruleDetailsUI.getAlertsList(); expect(alertsList.filter((a) => a.alert === 'eu/east')).to.eql([ { @@ -691,6 +700,9 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }); it('allows the user to mute a specific alert', async () => { + // If the tab exists, click on the alert list + await pageObjects.triggersActionsUI.maybeClickOnAlertTab(); + // Verify content await testSubjects.existOrFail('alertsList'); @@ -705,6 +717,9 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }); it('allows the user to unmute a specific alert', async () => { + // If the tab exists, click on the alert list + await pageObjects.triggersActionsUI.maybeClickOnAlertTab(); + // Verify content await testSubjects.existOrFail('alertsList'); @@ -725,6 +740,9 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }); it('allows the user unmute an inactive alert', async () => { + // If the tab exists, click on the alert list + await pageObjects.triggersActionsUI.maybeClickOnAlertTab(); + log.debug(`Ensuring eu/east is muted`); await pageObjects.ruleDetailsUI.ensureAlertMuteState('eu/east', true); @@ -778,6 +796,9 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { const PAGE_SIZE = 10; it('renders the first page', async () => { + // If the tab exists, click on the alert list + await pageObjects.triggersActionsUI.maybeClickOnAlertTab(); + // Verify content await testSubjects.existOrFail('alertsList'); @@ -791,6 +812,9 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }); it('navigates to the next page', async () => { + // If the tab exists, click on the alert list + await pageObjects.triggersActionsUI.maybeClickOnAlertTab(); + // Verify content await testSubjects.existOrFail('alertsList'); @@ -804,5 +828,120 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }); }); }); + + describe('Execution log', () => { + const testRunUuid = uuid.v4(); + let rule: any; + + before(async () => { + await pageObjects.common.navigateToApp('triggersActions'); + + const alerts = [{ id: 'us-central' }]; + rule = await createRuleWithActionsAndParams( + testRunUuid, + { + instances: alerts, + }, + { + schedule: { interval: '1s' }, + throttle: null, + } + ); + + // refresh to see rule + await browser.refresh(); + await pageObjects.header.waitUntilLoadingHasFinished(); + + // click on first rule + await pageObjects.triggersActionsUI.clickOnAlertInAlertsList(rule.name); + + // await first run to complete so we have an initial state + await retry.try(async () => { + const { alerts: alertInstances } = await getAlertSummary(rule.id); + expect(Object.keys(alertInstances).length).to.eql(alerts.length); + }); + }); + + after(async () => { + await objectRemover.removeAll(); + }); + + it('renders the event log list and can filter/sort', async () => { + await browser.refresh(); + + // Check to see if the experimental is enabled, if not, just return + const tabbedContentExists = await testSubjects.exists('ruleDetailsTabbedContent'); + if (!tabbedContentExists) { + return; + } + + // Ensure we have some log data to work with + await new Promise((resolve) => setTimeout(resolve, 5000)); + + const refreshButton = await testSubjects.find('superDatePickerApplyTimeButton'); + await refreshButton.click(); + + // List, date picker, and status picker all exists + await testSubjects.existOrFail('ruleEventLogList'); + await testSubjects.existOrFail('ruleEventLogListDatePicker'); + await testSubjects.existOrFail('ruleEventLogStatusFilterButton'); + + let statusFilter = await testSubjects.find('ruleEventLogStatusFilterButton'); + let statusNumber = await statusFilter.findByCssSelector('.euiNotificationBadge'); + + expect(statusNumber.getVisibleText()).to.eql(0); + + await statusFilter.click(); + await testSubjects.click('ruleEventLogStatusFilter-success'); + await statusFilter.click(); + + statusFilter = await testSubjects.find('ruleEventLogStatusFilterButton'); + statusNumber = await statusFilter.findByCssSelector('.euiNotificationBadge'); + + expect(statusNumber.getVisibleText()).to.eql(1); + + const eventLogList = await find.byCssSelector('.euiDataGridRow'); + const rows = await eventLogList.parseDomContent(); + expect(rows.length).to.be.greaterThan(0); + + await pageObjects.triggersActionsUI.ensureEventLogColumnExists('timestamp'); + await pageObjects.triggersActionsUI.ensureEventLogColumnExists('total_search_duration'); + + const timestampCells = await find.allByCssSelector( + '[data-gridcell-column-id="timestamp"][data-test-subj="dataGridRowCell"]' + ); + + // The test can be flaky and sometimes we'll get results without dates, + // This is a reasonable compromise as we still validate the good rows + let validTimestamps = 0; + await asyncForEach(timestampCells, async (cell) => { + const text = await cell.getVisibleText(); + if (text.toLowerCase() !== 'invalid date') { + if (moment(text).isValid()) { + validTimestamps += 1; + } + } + }); + expect(validTimestamps).to.be.greaterThan(0); + + // Ensure duration cells are properly formatted + const durationCells = await find.allByCssSelector( + '[data-gridcell-column-id="total_search_duration"][data-test-subj="dataGridRowCell"]' + ); + + await asyncForEach(durationCells, async (cell) => { + const text = await cell.getVisibleText(); + if (text) { + expect(text).to.match(/^N\/A|\d{2,}:\d{2}$/); + } + }); + + await pageObjects.triggersActionsUI.sortEventLogColumn('timestamp', 'asc'); + await pageObjects.triggersActionsUI.sortEventLogColumn('total_search_duration', 'asc'); + + await testSubjects.existOrFail('dataGridHeaderCellSortingIcon-timestamp'); + await testSubjects.existOrFail('dataGridHeaderCellSortingIcon-total_search_duration'); + }); + }); }); }; diff --git a/x-pack/test/functional_with_es_ssl/page_objects/triggers_actions_ui_page.ts b/x-pack/test/functional_with_es_ssl/page_objects/triggers_actions_ui_page.ts index 7379a5ad1329c5..e346971b48ea45 100644 --- a/x-pack/test/functional_with_es_ssl/page_objects/triggers_actions_ui_page.ts +++ b/x-pack/test/functional_with_es_ssl/page_objects/triggers_actions_ui_page.ts @@ -141,6 +141,12 @@ export function TriggersActionsPageProvider({ getService }: FtrProviderContext) await this.searchAlerts(name); await find.clickDisplayedByCssSelector(`[data-test-subj="rulesList"] [title="${name}"]`); }, + async maybeClickOnAlertTab() { + if (await testSubjects.exists('ruleDetailsTabbedContent')) { + const alertTab = await testSubjects.find('ruleAlertListTab'); + await alertTab.click(); + } + }, async changeTabs(tab: 'rulesTab' | 'connectorsTab') { await testSubjects.click(tab); }, @@ -195,5 +201,32 @@ export function TriggersActionsPageProvider({ getService }: FtrProviderContext) expect(title.toLowerCase()).to.eql(expectedStatus.toLowerCase()); }); }, + async ensureEventLogColumnExists(columnId: string) { + const columnsButton = await testSubjects.find('dataGridColumnSelectorButton'); + await columnsButton.click(); + + const button = await testSubjects.find( + `dataGridColumnSelectorToggleColumnVisibility-${columnId}` + ); + const isChecked = await button.getAttribute('aria-checked'); + + if (isChecked === 'false') { + await button.click(); + } + + await columnsButton.click(); + }, + async sortEventLogColumn(columnId: string, direction: string) { + await testSubjects.click(`dataGridHeaderCell-${columnId}`); + const popover = await testSubjects.find(`dataGridHeaderCellActionGroup-${columnId}`); + const popoverListItems = await popover.findAllByCssSelector('li'); + + if (direction === 'asc') { + await popoverListItems[1].click(); + } + if (direction === 'desc') { + await popoverListItems[2].click(); + } + }, }; } diff --git a/yarn.lock b/yarn.lock index ce17dc8768523d..6814b5463143ed 100644 --- a/yarn.lock +++ b/yarn.lock @@ -19048,9 +19048,9 @@ locate-path@^6.0.0: p-locate "^5.0.0" lodash-es@^4.17.11: - version "4.17.15" - resolved "https://registry.yarnpkg.com/lodash-es/-/lodash-es-4.17.15.tgz#21bd96839354412f23d7a10340e5eac6ee455d78" - integrity sha512-rlrc3yU3+JNOpZ9zj5pQtxnx2THmvRykwL4Xlxoa8I9lHBlVbbyPhgyPMioxVZ4NqyxaVVtaJnzsyOidQIhyyQ== + version "4.17.21" + resolved "https://registry.yarnpkg.com/lodash-es/-/lodash-es-4.17.21.tgz#43e626c46e6591b7750beb2b50117390c609e3ee" + integrity sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw== lodash._reinterpolate@^3.0.0: version "3.0.0"