mirror of
https://github.com/elastic/kibana.git
synced 2025-04-20 07:48:52 -04:00
Documentation and type tweaks
This commit is contained in:
parent
75f837a859
commit
73e601f2bc
2 changed files with 5 additions and 2 deletions
|
@ -36,7 +36,7 @@ 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,
|
||||
|
@ -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[];
|
||||
}
|
||||
|
|
|
@ -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;
|
||||
}
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue