docs(saved-objects): consolidate docs and document scoped vs system client by gsoldevila · Pull Request #260743 · elastic/kibana

gsoldevila · 2026-04-01T14:44:22Z

Summary

Moves all content from dev_docs/key_concepts/saved_objects.mdx into the canonical docs/extend/saved-objects/ section. The old page now shows a short redirect note pointing to https://www.elastic.co/docs/extend/kibana/saved-objects.
Enriches docs/extend/saved-objects.md (overview) with four conceptual sections missing from the new docs: Security (space awareness, feature controls/RBAC, OLS), Scalability, Searchability, and Saved Objects by value vs by reference.
Enriches docs/extend/saved-objects/use.md with guidance on obtaining a scoped vs system client, incorporating Tina's suggestions from [Docs][Saved Objects] Add section explaining scoped vs. system clients #124280 (comment):
- Callout that getUnsafeInternalClient defaults to the default space and how to use namespaces: ['*'] to query across all spaces.
- Warning against manually instantiating SavedObjectsClient with a non-default repository, which bypasses security, spaces, and Encrypted Saved Object wrappers.
- New "Security considerations" section covering aggregation security risks when using find/search.

Test plan

Verify the redirect note renders correctly on the dev docs site (dev_docs/key_concepts/saved_objects.mdx).
Verify the new sections render correctly on the canonical saved-objects overview page.
Verify the new sections in use.md render correctly.
Confirm no broken internal links.

…lient Closes elastic#124280 Moves all content from `dev_docs/key_concepts/saved_objects.mdx` into the canonical `docs/extend/saved-objects/` section and leaves a short redirect note with a link to the new location. Additions to `docs/extend/saved-objects.md` (overview): - Security: space awareness, feature controls/RBAC, OLS (planned) - Scalability: per-type dedicated index via `indexPattern` - Searchability: system-index limitation ("X as data") - Saved Objects by value vs by reference Additions to `docs/extend/saved-objects/use.md`: - Callout explaining that `getUnsafeInternalClient` defaults to the `default` space and how to use `namespaces: ['*']` to query across all spaces (Tina's suggestion, elastic#124280 (comment)) - Warning against manually instantiating `SavedObjectsClient` with a non-default repository, which bypasses security/spaces/ESO wrappers - New "Security considerations" section covering aggregation security risks when using `find`/`search` with aggregations Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

leemthompo · 2026-04-01T14:50:13Z

@gsoldevila docs eng had to some security work to harden the docs build pipelines, and a side effect is that when working from a fork, we now need your profile to be public to verify elastic org membership and then enable automatic docs previews

You can do that simply by flipping to public here: https://github.com/orgs/elastic/people?query=gsoldevila

The alternative is to build locally: https://www.elastic.co/docs/contribute-docs/locally#install-docs-builder

elasticmachine · 2026-04-01T14:52:59Z

Pinging @elastic/kibana-core (Team:Core)

florent-leborgne

LGTM! Some small comments, feel free to leave or take!

Co-authored-by: Florent LB <florent.leborgne@elastic.co>

gsoldevila · 2026-04-01T16:48:58Z

/sync-ci

gsoldevila · 2026-04-01T16:49:22Z

/ci-sync

gsoldevila · 2026-04-01T17:36:56Z

/ci

elasticmachine · 2026-04-01T18:32:04Z

💔 Build Failed

Buildkite Build
Commit: 9ac730e

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #63 / Agent Builder converse Conversation Error Handling "after all" hook for "keeps the previous conversation rounds visible when there is an error"
[job] [logs] FTR Configs #63 / Agent Builder converse Conversation Error Handling "after all" hook for "keeps the previous conversation rounds visible when there is an error"
[job] [logs] FTR Configs #63 / Agent Builder converse Conversation Error Handling shows error message when there is an error and allows user to retry
[job] [logs] FTR Configs #63 / Agent Builder converse Conversation Error Handling shows error message when there is an error and allows user to retry

Metrics [docs]

✅ unchanged

History

…heck * commit 'af66aadafa7470ca8ba3e3edd3793bde81fa4596': (31 commits) [Scout] Update test config manifests (elastic#260850) [SLO]: register alerts schema embeddable (elastic#256570) [Discover][Flyout] Update overview fields table with new prop headerVisibility set to false (elastic#260692) [AiButton/Security] Migrate ai-related buttons to use custom styles (elastic#259847) [One Workflow] Fix connector step icons falling back to generic plugs in YAML editor (elastic#260785) [Agent Builder] Dashboard skill: Guard against editing non-ESQL based panels (elastic#260714) Security quality gate Cypress cleanup - Periodic Pipeline (elastic#260820) [Search] Deprecate search indices in favour of index management (elastic#260210) Upgrade dependency @elastic/charts to v71.4.0 (elastic#260593) [Security Solution] [HDQ]: integration-based targeting and descriptor versioning (elastic#258418) docs(saved-objects): consolidate docs and document scoped vs system client (elastic#260743) Fix observability UIAM config and add CPS observability variant (elastic#260485) [Security Solution] Add "matched_indices_count" rule execution metric (elastic#259938) [SigEvents] Add callout with working promote action. (elastic#260433) [Alerting V2] Episode table actions (elastic#260195) [Automatic Migration] Add ability to skip Reference Set step in QRadar upload workflow (elastic#259959) [Rules] KQL-to-DSL conversion without data view produces incorrect queries for keyword fields for Metric threshold rule (elastic#260046) Update dependency lightningcss to v1.32.0 (main) (elastic#259017) Update postcss (main) (elastic#255420) Migrate server-side apm.addLabels to OTel dual-write helpers (elastic#259619) ...

…lient (elastic#260743) Closes elastic#124280 ## Summary - **Moves** all content from `dev_docs/key_concepts/saved_objects.mdx` into the canonical `docs/extend/saved-objects/` section. The old page now shows a short redirect note pointing to https://www.elastic.co/docs/extend/kibana/saved-objects. - **Enriches** `docs/extend/saved-objects.md` (overview) with four conceptual sections missing from the new docs: Security (space awareness, feature controls/RBAC, OLS), Scalability, Searchability, and Saved Objects by value vs by reference. - **Enriches** `docs/extend/saved-objects/use.md` with guidance on obtaining a scoped vs system client, incorporating Tina's suggestions from elastic#124280 (comment): - Callout that `getUnsafeInternalClient` defaults to the `default` space and how to use `namespaces: ['*']` to query across all spaces. - Warning against manually instantiating `SavedObjectsClient` with a non-default repository, which bypasses security, spaces, and Encrypted Saved Object wrappers. - New "Security considerations" section covering aggregation security risks when using `find`/`search`. ## Test plan - [ ] Verify the redirect note renders correctly on the dev docs site (`dev_docs/key_concepts/saved_objects.mdx`). - [ ] Verify the new sections render correctly on the canonical saved-objects overview page. - [ ] Verify the new sections in `use.md` render correctly. - [ ] Confirm no broken internal links. --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Florent LB <florent.leborgne@elastic.co>

#261013) ## Summary PR #260743 introduced docs-builder syntax on docsmobile pages, breaking the pipeline: ``` Error occurred prerendering page "/kibana-dev-docs/key-concepts/saved-objects-intro". [...] ReferenceError: note is not defined ``` Removing the `note` declaration should unblock deployments, and puts the current statement in line with others already present.

gsoldevila added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Apr 1, 2026

gsoldevila requested a review from florent-leborgne April 1, 2026 14:52

Merge branch 'main' into claude/quizzical-swirles

714bcde

florent-leborgne approved these changes Apr 1, 2026

View reviewed changes

Comment thread docs/extend/saved-objects/use.md Outdated

Comment thread docs/extend/saved-objects/use.md Outdated

Comment thread docs/extend/saved-objects/use.md Outdated

Comment thread docs/extend/saved-objects.md Outdated

Comment thread docs/extend/saved-objects.md Outdated

gsoldevila and others added 5 commits April 1, 2026 18:01

Update docs/extend/saved-objects/use.md

9e06775

Co-authored-by: Florent LB <florent.leborgne@elastic.co>

Update docs/extend/saved-objects/use.md

279be8f

Co-authored-by: Florent LB <florent.leborgne@elastic.co>

Update docs/extend/saved-objects/use.md

fb3ce01

Co-authored-by: Florent LB <florent.leborgne@elastic.co>

Update docs/extend/saved-objects.md

6a014b2

Co-authored-by: Florent LB <florent.leborgne@elastic.co>

Update docs/extend/saved-objects.md

b2c2b6c

Co-authored-by: Florent LB <florent.leborgne@elastic.co>

florent-leborgne reviewed Apr 1, 2026

View reviewed changes

Comment thread docs/extend/saved-objects/use.md Outdated

Update docs/extend/saved-objects/use.md

9ac730e

Co-authored-by: Florent LB <florent.leborgne@elastic.co>

Merge branch 'main' into claude/quizzical-swirles

ab7e825

gsoldevila merged commit 9e4835a into elastic:main Apr 2, 2026
16 checks passed

kibanamachine added the v9.4.0 label Apr 2, 2026

cotti mentioned this pull request Apr 2, 2026

docs(saved-objects): Remove docs-builder syntax from saved_objects.mdx #261013

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(saved-objects): consolidate docs and document scoped vs system client#260743

docs(saved-objects): consolidate docs and document scoped vs system client#260743
gsoldevila merged 9 commits intoelastic:mainfrom
gsoldevila:claude/quizzical-swirles

gsoldevila commented Apr 1, 2026

Uh oh!

leemthompo commented Apr 1, 2026

Uh oh!

elasticmachine commented Apr 1, 2026

Uh oh!

florent-leborgne left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gsoldevila commented Apr 1, 2026

Uh oh!

gsoldevila commented Apr 1, 2026

Uh oh!

gsoldevila commented Apr 1, 2026

Uh oh!

elasticmachine commented Apr 1, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

gsoldevila commented Apr 1, 2026

Summary

Test plan

Uh oh!

leemthompo commented Apr 1, 2026

Uh oh!

elasticmachine commented Apr 1, 2026

Uh oh!

florent-leborgne left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gsoldevila commented Apr 1, 2026

Uh oh!

gsoldevila commented Apr 1, 2026

Uh oh!

gsoldevila commented Apr 1, 2026

Uh oh!

elasticmachine commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Failed CI Steps

Test Failures

Metrics [docs]

History

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

elasticmachine commented Apr 1, 2026 •

edited

Loading