From 250d0345af73a70e6fbb799b0fcd11c7e783c429 Mon Sep 17 00:00:00 2001 From: Timothy Sullivan Date: Thu, 14 Jul 2022 17:48:22 -0700 Subject: [PATCH] add comments for public api items --- src/plugins/data_views/common/data_views/data_views.ts | 4 ++++ .../data_views/server/fetcher/lib/map_capabilities.ts | 5 ++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/src/plugins/data_views/common/data_views/data_views.ts b/src/plugins/data_views/common/data_views/data_views.ts index 1a3ad60a20d63..258a02c8dcdf3 100644 --- a/src/plugins/data_views/common/data_views/data_views.ts +++ b/src/plugins/data_views/common/data_views/data_views.ts @@ -38,6 +38,10 @@ import { DuplicateDataViewError, DataViewInsufficientAccessError } from '../erro const MAX_ATTEMPTS_TO_RESOLVE_CONFLICTS = 3; +/* + * Attributes of the data view saved object + * @public + */ export type DataViewSavedObjectAttrs = Pick< DataViewAttributes, 'title' | 'type' | 'typeMeta' | 'name' diff --git a/src/plugins/data_views/server/fetcher/lib/map_capabilities.ts b/src/plugins/data_views/server/fetcher/lib/map_capabilities.ts index 147272b74284d..a5fdf98bd03e9 100644 --- a/src/plugins/data_views/server/fetcher/lib/map_capabilities.ts +++ b/src/plugins/data_views/server/fetcher/lib/map_capabilities.ts @@ -12,9 +12,12 @@ import { AggregationRestrictions } from '../../../common'; import { mergeJobConfigurations } from './jobs_compatibility'; /** - * A record of capabilities (aggregations) for an index rollup job + * A record of capabilities (aggregations) for index rollup jobs */ export interface RollupIndexCapability { + /** + * A record of capabilities (aggregations) for an index rollup job + */ [index: string]: { aggs?: Dictionary; error?: string }; }