github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

Documentation and type tweaks

Browse source
This commit is contained in:
Rudolf Meijering 2019-07-29 14:01:34 +02:00
parent 75f837a859
commit 73e601f2bc
2 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/core/public/saved_objects/saved_objects_client.ts
View file

@ -36,7 +36,7 @@ import {
import { SimpleSavedObject } from './simple_saved_object'; import { SimpleSavedObject } from './simple_saved_object';
import { HttpFetchQuery, HttpSetup } from '../http'; import { HttpFetchQuery, HttpSetup } from '../http';
type SavedObjectsFindOptions = Omit<SavedObjectFindOptionsServer, 'namespace' | 'sortOrder'>; export type SavedObjectsFindOptions = Omit<SavedObjectFindOptionsServer, 'namespace' | 'sortOrder'>;
export { export {
SavedObject, SavedObject,
@ -44,7 +44,6 @@ export {
SavedObjectAttributes, SavedObjectAttributes,
SavedObjectReference, SavedObjectReference,
SavedObjectsBaseOptions, SavedObjectsBaseOptions,
SavedObjectsFindOptions,
SavedObjectsMigrationVersion, SavedObjectsMigrationVersion,
} from '../../server/types'; } from '../../server/types';
@ -65,6 +64,7 @@ export interface SavedObjectsCreateOptions {
id?: string; id?: string;
/** If a document with the given `id` already exists, overwrite it's contents (default=false). */ /** If a document with the given `id` already exists, overwrite it's contents (default=false). */
overwrite?: boolean; overwrite?: boolean;
/** {@inheritDoc SavedObjectsMigrationVersion} */
migrationVersion?: SavedObjectsMigrationVersion; migrationVersion?: SavedObjectsMigrationVersion;
references?: SavedObjectReference[]; references?: SavedObjectReference[];
} }
@ -91,6 +91,7 @@ export interface SavedObjectsBulkCreateOptions {
/** @public */ /** @public */
export interface SavedObjectsUpdateOptions { export interface SavedObjectsUpdateOptions {
version?: string; version?: string;
/** {@inheritDoc SavedObjectsMigrationVersion} */
migrationVersion?: SavedObjectsMigrationVersion; migrationVersion?: SavedObjectsMigrationVersion;
references?: SavedObjectReference[]; references?: SavedObjectReference[];
} }

2
src/core/server/saved_objects/service/saved_objects_client.ts
View file

@ -39,6 +39,7 @@ export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions {
id?: string; id?: string;
/** Overwrite existing documents (defaults to false) */ /** Overwrite existing documents (defaults to false) */
overwrite?: boolean; overwrite?: boolean;
/** {@inheritDoc SavedObjectsMigrationVersion} */
migrationVersion?: SavedObjectsMigrationVersion; migrationVersion?: SavedObjectsMigrationVersion;
references?: SavedObjectReference[]; references?: SavedObjectReference[];
} }
@ -52,6 +53,7 @@ export interface SavedObjectsBulkCreateObject<T extends SavedObjectAttributes =
type: string; type: string;
attributes: T; attributes: T;
references?: SavedObjectReference[]; references?: SavedObjectReference[];
/** {@inheritDoc SavedObjectsMigrationVersion} */
migrationVersion?: SavedObjectsMigrationVersion; migrationVersion?: SavedObjectsMigrationVersion;
} }