github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Saved Objects] Update resolve doc comment (#150540)

Browse source 
## Summary

Per title
This commit is contained in:
Jean-Louis Leysens 2023-02-08 13:15:48 +01:00 • committed by GitHub
parent 86e91b72dd
commit e770455173
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts
View file

@ -210,7 +210,9 @@ export interface SavedObjectsClientContract {
): Promise<SavedObject<T>>;
/**
* Resolves an array of objects by id, using any legacy URL aliases if they exist
* Resolves an array of objects by id.
*
* See documentation for `.resolve`.
*
* @param objects - an array of objects to resolve (contains id and type)
* @param options {@link SavedObjectsBaseOptions} - options for the bulk resolve operation
@ -232,7 +234,15 @@ export interface SavedObjectsClientContract {
): Promise<SavedObjectsBulkResolveResponse<T>>;
/**
* Resolves a single object, using any legacy URL alias if it exists
* Resolves a single object.
*
* After 8.0.0, saved objects are provided a unique ID _across_ spaces.
* A subset of existing saved objects may have IDs regenerated while upgrading to 8+.
* `.resolve` provides a way for clients with legacy IDs to still retrieve the correct
* saved object.
*
* An example of a client with a "legacy ID" is a bookmarked dashboard in a
* non-default space.
*
* @param type - The type of SavedObject to retrieve
* @param id - The ID of the SavedObject to retrieve