Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance documentation on accessing hidden SO types #199046

Merged

Conversation

TinaHeiligers
Copy link
Contributor

@TinaHeiligers TinaHeiligers commented Nov 5, 2024

Saved objects declared as hidden can only be accessed with a client that explicitly includes hidden types.

Checklist

  • Documentation was added for features that require explanation or tutorials

@TinaHeiligers TinaHeiligers added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes v9.0.0 DevDocs backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.17.0 labels Nov 5, 2024
@TinaHeiligers TinaHeiligers requested a review from a team as a code owner November 5, 2024 19:21
@elasticmachine
Copy link
Contributor

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

dev_docs/tutorials/saved_objects.mdx Outdated Show resolved Hide resolved
dev_docs/tutorials/saved_objects.mdx Outdated Show resolved Hide resolved
Co-authored-by: Alejandro Fernández Haro <[email protected]>
@TinaHeiligers TinaHeiligers enabled auto-merge (squash) November 6, 2024 00:07
@TinaHeiligers TinaHeiligers merged commit 73f3154 into elastic:main Nov 6, 2024
22 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11695745452

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Nov 6, 2024
Saved objects declared as `hidden` can only be accessed with a client
that explicitly includes hidden types.

### Checklist

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

---------

Co-authored-by: Alejandro Fernández Haro <[email protected]>
(cherry picked from commit 73f3154)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Nov 6, 2024
…199075)

# Backport

This will backport the following commits from `main` to `8.x`:
- [Enhance documentation on accessing hidden SO types
(#199046)](#199046)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Christiane (Tina)
Heiligers","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-06T01:51:45Z","message":"Enhance
documentation on accessing hidden SO types (#199046)\n\nSaved objects
declared as `hidden` can only be accessed with a client\r\nthat
explicitly includes hidden types.\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or
tutorials\r\n\r\n---------\r\n\r\nCo-authored-by: Alejandro Fernández
Haro
<[email protected]>","sha":"73f31549cd0ae6c4aa5cc505907e455d16307190","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","Feature:Saved
Objects","release_note:skip","v9.0.0","DevDocs","backport:prev-minor","v8.17.0"],"title":"Enhance
documentation on accessing hidden SO
types","number":199046,"url":"https://github.com/elastic/kibana/pull/199046","mergeCommit":{"message":"Enhance
documentation on accessing hidden SO types (#199046)\n\nSaved objects
declared as `hidden` can only be accessed with a client\r\nthat
explicitly includes hidden types.\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or
tutorials\r\n\r\n---------\r\n\r\nCo-authored-by: Alejandro Fernández
Haro
<[email protected]>","sha":"73f31549cd0ae6c4aa5cc505907e455d16307190"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199046","number":199046,"mergeCommit":{"message":"Enhance
documentation on accessing hidden SO types (#199046)\n\nSaved objects
declared as `hidden` can only be accessed with a client\r\nthat
explicitly includes hidden types.\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or
tutorials\r\n\r\n---------\r\n\r\nCo-authored-by: Alejandro Fernández
Haro
<[email protected]>","sha":"73f31549cd0ae6c4aa5cc505907e455d16307190"}},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Christiane (Tina) Heiligers <[email protected]>
mgadewoll pushed a commit to mgadewoll/kibana that referenced this pull request Nov 7, 2024
Saved objects declared as `hidden` can only be accessed with a client
that explicitly includes hidden types.

### Checklist

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

---------

Co-authored-by: Alejandro Fernández Haro <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) DevDocs Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants