POC: Sharing Saved Objects developer guide steps #107256
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jportner
added
release_note:skip
jportner
changed the title
jportner
force-pushed
the
poc-sharing-saved-objects
branch
from
d3fcabe
to
531730d
Compare
Created the test plugin with basic functionality. Subsequent commits will demonstrate individual steps that need to be taken, as described by the Sharing Saved Objects developer guide. Note: this simple test plugin doesn't use links to other object types, so Step 1 is skipped intentionally.
This step demonstrates the changes to update client code to use the new SavedObjectsClient `resolve()` method instead of `get()`.
This step demonstrates the changes to update client code to correctly handle the three different `resolve()` outcomes. It adds an optional dependency on the Spaces plugin, and uses the SpacesApi to change the UI if necessary.
This step demonstrate the changes to update the saved object type registration, which will cause this isolated object type to be converted to become share-capable during the 8.0 upgrade process. Note: the previous steps can be backported to 7.x, but this step cannot be backported, because the conversion cannot take place before 8.0.
jportner
force-pushed
the
poc-sharing-saved-objects
branch
from
531730d
to
2fd4c42
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[skip-ci]
This PR is a proof-of-concept. It is designed to be a companion for the Sharing Saved Objects developer guide (added in #107099).
Example steps #
The proof-of-concept adds a new example plugin called Notes Test (added in a084bf0). This plugin registers an isolated "note" saved object type (
namespaceType: 'single'). The subsequent commits walk through the steps of the developer guide to convert the "note" objects to become share-capable.Using the example plugin
Open Kibana and use the main navigation pane to view the Notes Test app. You can use this page to view a table of notes or create a new note. You can click an existing note to view its body text.