Documentation and type tweaks

rudolf · Jul 29, 2019 · 73e601f · 73e601f
1 parent 75f837a
commit 73e601f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/src/core/public/saved_objects/saved_objects_client.ts b/src/core/public/saved_objects/saved_objects_client.ts
@@ -36,15 +36,14 @@ import {
 import { SimpleSavedObject } from './simple_saved_object';
 import { HttpFetchQuery, HttpSetup } from '../http';
 
-type SavedObjectsFindOptions = Omit<SavedObjectFindOptionsServer, 'namespace' | 'sortOrder'>;
+export type SavedObjectsFindOptions = Omit<SavedObjectFindOptionsServer, 'namespace' | 'sortOrder'>;
 
 export {
   SavedObject,
   SavedObjectAttribute,
   SavedObjectAttributes,
   SavedObjectReference,
   SavedObjectsBaseOptions,
-  SavedObjectsFindOptions,
   SavedObjectsMigrationVersion,
 } from '../../server/types';
 
@@ -65,6 +64,7 @@ export interface SavedObjectsCreateOptions {
   id?: string;
   /** If a document with the given `id` already exists, overwrite it's contents (default=false). */
   overwrite?: boolean;
+  /** {@inheritDoc SavedObjectsMigrationVersion} */
   migrationVersion?: SavedObjectsMigrationVersion;
   references?: SavedObjectReference[];
 }
@@ -91,6 +91,7 @@ export interface SavedObjectsBulkCreateOptions {
 /** @public */
 export interface SavedObjectsUpdateOptions {
   version?: string;
+  /** {@inheritDoc SavedObjectsMigrationVersion} */
   migrationVersion?: SavedObjectsMigrationVersion;
   references?: SavedObjectReference[];
 }

diff --git a/src/core/server/saved_objects/service/saved_objects_client.ts b/src/core/server/saved_objects/service/saved_objects_client.ts
@@ -39,6 +39,7 @@ export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions {
   id?: string;
   /** Overwrite existing documents (defaults to false) */
   overwrite?: boolean;
+  /** {@inheritDoc SavedObjectsMigrationVersion} */
   migrationVersion?: SavedObjectsMigrationVersion;
   references?: SavedObjectReference[];
 }
@@ -52,6 +53,7 @@ export interface SavedObjectsBulkCreateObject<T extends SavedObjectAttributes =
   type: string;
   attributes: T;
   references?: SavedObjectReference[];
+  /** {@inheritDoc SavedObjectsMigrationVersion} */
   migrationVersion?: SavedObjectsMigrationVersion;
 }