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

Docs should recommend hidden=true saved objects #149283

Closed
exalate-issue-sync bot opened this issue Jan 20, 2023 · 3 comments
Closed

Docs should recommend hidden=true saved objects #149283

exalate-issue-sync bot opened this issue Jan 20, 2023 · 3 comments
Assignees
Labels
Epic:VersionedAPIs Kibana Versioned APIs Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@exalate-issue-sync
Copy link

While there is a lot of design work left before we can create a thorough BWCA “migration guide”, one thing that we’re sure about is that all saved objects will have to become hidden: true. All of our documentation and examples show exactly the opposite. We also have teams with existing public APIs who are still using {{hidden: false}} saved objects (e.g. data views and security solution) but we don’t have any documentation for them to use a reference

As a starting point we can update our documentation and examples to highlight the purpose of the hidden option and to have enough reference material so they know how to migrate away from that. (For instance highlighting that they need to construct a new SO client with the hidden type enabled to be able to use it)

@botelastic botelastic bot added the needs-team Issues missing a team label label Jan 20, 2023
@jloleysens jloleysens added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Epic:VersionedAPIs Kibana Versioned APIs labels Jan 20, 2023
@elasticmachine
Copy link
Contributor

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

@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 20, 2023
@TinaHeiligers
Copy link
Contributor

The alternative to changing a saved object type to hidden:true will be only 'hiding' the type from the public HTTP APIs by declaring hiddenFromHttpApis: true. The latter option will allow type owners to use their own domain-specific HTTP APIs without having to use a custom client.

@rudolf
Copy link
Contributor

rudolf commented Jan 27, 2023

This was fixed in #144647 let's create a new issue to update our docs to recommend hiddenFromHttpApis: true

@rudolf rudolf closed this as completed Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic:VersionedAPIs Kibana Versioned APIs Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

No branches or pull requests

5 participants