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

[Deprecation Service] Add namespaces callout to the docs (#202768)

Browse source
This commit is contained in:
Alejandro Fernández Haro 2024-12-12 18:56:47 +01:00 • committed by GitHub
parent 231f1b3fca
commit a1a78d1dc4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/core/server/docs/kib_core_deprecations_service.mdx
View file

@ -152,9 +152,13 @@ coreSetup.deprecations.registerDeprecations({
```
The `getDeprecations` function is invoked when the user requests to see the deprecations affecting their deployment.
The function provides a context object which contains a scoped Elasticsearch client and a saved objects client.
The function provides a context object which contains a scoped Elasticsearch client and a Saved Objects client.
To check the full TS types of the service please check the [generated core docs](../../../../docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md).
⚠️When using the Saved Objects client, bear in mind that all Spaces must be checked for deprecations:
By default, the Saved Objects client retrieves data from the current Space only. To override this behavior, add the
option `namespaces: ['*']` to search in all Spaces. When getting by ID, it's best to loop through all the spaces and get with `namespaces: [mySpaceOverride]`.
To check the full TS types of the service please check the [generated core docs](https://docs.elastic.dev/kibana-dev-docs/api/kbn-core-deprecations-server).
### Example
```ts