add comments for public api items

elastic · Jul 15, 2022 · 250d034 · 250d034
1 parent 35c4dcf
commit 250d034
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 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
@@ -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
@@ -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<AggregationRestrictions>; error?: string };
 }