From 73e601f2bc0554175002d7732f6df8ce92652964 Mon Sep 17 00:00:00 2001 From: Rudolf Meijering Date: Mon, 29 Jul 2019 14:01:34 +0200 Subject: [PATCH] Documentation and type tweaks --- src/core/public/saved_objects/saved_objects_client.ts | 5 +++-- .../server/saved_objects/service/saved_objects_client.ts | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/core/public/saved_objects/saved_objects_client.ts b/src/core/public/saved_objects/saved_objects_client.ts index 8aa6accb84a4cd..cca3b1b74b3b38 100644 --- a/src/core/public/saved_objects/saved_objects_client.ts +++ b/src/core/public/saved_objects/saved_objects_client.ts @@ -36,7 +36,7 @@ import { import { SimpleSavedObject } from './simple_saved_object'; import { HttpFetchQuery, HttpSetup } from '../http'; -type SavedObjectsFindOptions = Omit; +export type SavedObjectsFindOptions = Omit; export { SavedObject, @@ -44,7 +44,6 @@ export { 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 index 27d8a2e6201944..3b1a0beef40da5 100644 --- 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