Skip to content

Commit

Permalink
update generated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pgayvallet committed Jan 21, 2021
1 parent 4f292e9 commit 9ac648f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,6 @@ export interface SavedObjectsTypeManagementDefinition
| [getTitle](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md) | <code>(savedObject: SavedObject&lt;any&gt;) =&gt; string</code> | Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label. |
| [icon](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md) | <code>string</code> | The eui icon name to display in the management table. If not defined, the default icon will be used. |
| [importableAndExportable](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md) | <code>boolean</code> | Is the type importable or exportable. Defaults to <code>false</code>. |
| [onExport](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md) | <code>SavedObjectsExportTransform</code> | An optional export transform function that can be used transform the objects of the registered type during the export process.<!-- -->It can be used to either mutates the exported objects, or add new objects to the export list.<!-- -->See [the transform type documentation](./kibana-plugin-core-server.savedobjectsexporttransform.md) for more info and examples. |
| [onImport](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md) | <code>SavedObjectsImportHook</code> | An optional [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) to use when importing given type.<!-- -->Import hooks are executed during the savedObjects import process and allow to interact with the imported objects. See the [hook documentation](./kibana-plugin-core-server.savedobjectsimporthook.md) for more info. |

15 changes: 14 additions & 1 deletion src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2079,6 +2079,7 @@ export interface SavedObjectExportBaseOptions {
excludeExportDetails?: boolean;
includeReferencesDeep?: boolean;
namespace?: string;
request: KibanaRequest;
}

// @public
Expand Down Expand Up @@ -2403,8 +2404,9 @@ export interface SavedObjectsExportByTypeOptions extends SavedObjectExportBaseOp
export class SavedObjectsExporter {
// (undocumented)
#private;
constructor({ savedObjectsClient, exportSizeLimit, }: {
constructor({ savedObjectsClient, typeRegistry, exportSizeLimit, }: {
savedObjectsClient: SavedObjectsClientContract;
typeRegistry: ISavedObjectTypeRegistry;
exportSizeLimit: number;
});
exportByObjects(options: SavedObjectsExportByObjectOptions): Promise<import("stream").Readable>;
Expand All @@ -2418,8 +2420,10 @@ export class SavedObjectsExportError extends Error {
readonly attributes?: Record<string, any> | undefined;
// (undocumented)
static exportSizeExceeded(limit: number): SavedObjectsExportError;
static invalidTransformError(objectKeys: string[]): SavedObjectsExportError;
// (undocumented)
static objectFetchError(objects: SavedObject[]): SavedObjectsExportError;
static objectTransformError(objects: SavedObject[], cause: Error): SavedObjectsExportError;
// (undocumented)
readonly type: string;
}
Expand All @@ -2434,6 +2438,14 @@ export interface SavedObjectsExportResultDetails {
}>;
}

// @public
export type SavedObjectsExportTransform = <T = unknown>(context: SavedObjectsExportTransformContext, objects: Array<SavedObject<T>>) => SavedObject[] | Promise<SavedObject[]>;

// @public
export interface SavedObjectsExportTransformContext {
request: KibanaRequest;
}

// @public
export type SavedObjectsFieldMapping = SavedObjectsCoreFieldMapping | SavedObjectsComplexFieldMapping;

Expand Down Expand Up @@ -2852,6 +2864,7 @@ export interface SavedObjectsTypeManagementDefinition {
getTitle?: (savedObject: SavedObject<any>) => string;
icon?: string;
importableAndExportable?: boolean;
onExport?: SavedObjectsExportTransform;
onImport?: SavedObjectsImportHook;
}

Expand Down

0 comments on commit 9ac648f

Please sign in to comment.