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

Saved Objects API as production feature #987

Open
inf17101 opened this issue Nov 29, 2021 · 5 comments
Open

Saved Objects API as production feature #987

inf17101 opened this issue Nov 29, 2021 · 5 comments
Assignees
Labels
backlog Issues that the Dashboards core team is interested in pursuing but are not yet on the roadmap discuss docs Improvements or additions to documentation question Further information is requested

Comments

@inf17101
Copy link

Are you planning to introduce the Saved Objects API as a fixed productive feature or is the Saved Objects API exactly like Elastic since a few versions experimental?

If it is experimental, will it be available always and continuously and eventually be passed over as a productive feature?

We want to import and export changed versions of visualizations and dashboards and for the purpose of automation we want to use the Saved Objects API permanently to import changed dashboards for different customers.

It would be nice to have a reliable Saved Objects API that is also maintained and is recommended to use productively, hence the feature request.

@anasalkouz anasalkouz transferred this issue from opensearch-project/OpenSearch Nov 30, 2021
@tmarkley tmarkley added the question Further information is requested label Nov 30, 2021
@tmarkley tmarkley changed the title Saved Objects API as productive feature Saved Objects API as production feature Nov 30, 2021
@tmarkley tmarkley added discuss backlog Issues that the Dashboards core team is interested in pursuing but are not yet on the roadmap docs Improvements or additions to documentation labels Nov 30, 2021
@tmarkley
Copy link
Contributor

We don't currently have Dashboards APIs documented in the opensearch.org docs site, so that's certainly a gap. We're also working on determining how to handle "experimental" features/APIs for OpenSearch Dashboards moving forward. We don't currently have any plans on the roadmap to change the Saved Objects API.

@tmarkley
Copy link
Contributor

@ahopp it'd be great to get your thoughts here too.

@tmarkley
Copy link
Contributor

Related to #800

@ahopp
Copy link
Contributor

ahopp commented Dec 14, 2021

@inf17101 we don't have any expectation of dropping Saved Objects API. While we can't say "always and continuously" with any feature, we currently expect it to be maintained.

@tmarkley I think we should drop the "experimental" as it's part of the product in my opinion and we should maintain. But we should also make sure we continue to elevate the code as there are some opportunities to improve (e.g. error codes).

@sastorsl
Copy link

sastorsl commented May 31, 2022

A couple of basic examples in the docs would be nice.
For instance something similar to the OpenSearch Popular API's.

# Export all saved objects for backup purposes
curl \
    -snk \
    --netrc-file ~/.netrc \
    -H "Content-Type: application/json" \
    -H "osd-xsrf:true" \
    -o /tmp/opensearch-dashboards-export.json \
    -XPOST \
    https://my.opensearch-dashboards.url/api/saved_objects/_export \
    -d '{"type":["index-pattern","config","search","dashboard","url","query","visualization"],"includeReferencesDeep":true}'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Issues that the Dashboards core team is interested in pursuing but are not yet on the roadmap discuss docs Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants