Deprecates SavedObjectType migrations and schemas in favor of modelVersions #176970
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
TinaHeiligers
added
Team:Core
|
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
|
/ci |
|
Pinging @elastic/kibana-core (Team:Core) |
lcawl
reviewed
Feb 15, 2024
| otherwise there will be no validating when importing objects_ | ||
|
|
||
| For implementation examples, refer to <<saved-objects-service-use-case-examples, Use-case examples>>. | ||
| === Use-case examples |
There was a problem hiding this comment.
I think if you want to link to this section, you need an anchor, for example:
Suggested change
| === Use-case examples | |
| [[saved-objects-service-use-case-examples]] | |
| === Use-case examples |
There was a problem hiding this comment.
oops,
Thanks!
TinaHeiligers
commented
Feb 15, 2024
| @@ -0,0 +1,761 @@ | |||
| [[saved-objects-service-use-case-examples]] | |||
There was a problem hiding this comment.
These should be on a different page but we can't nest off of a nested page.
TinaHeiligers
commented
Feb 15, 2024
| @@ -0,0 +1,761 @@ | |||
| [[saved-objects-service-use-case-examples]] | |||
| === Use-case examples | |||
There was a problem hiding this comment.
These examples come from the modelVersions.md doc
TinaHeiligers
commented
Feb 15, 2024
| @@ -70,6 +70,7 @@ export interface SavedObjectsType<Attributes = any> { | |||
| mappings: SavedObjectsTypeMappingDefinition; | |||
| /** | |||
| * An optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type. | |||
| * @deprecated Use {@link SavedObjectsType.modelVersions | modelVersions} instead. | |||
There was a problem hiding this comment.
Deprecates legacy properties to make it clear that going forward, changes have to be defined with new model versions.
TinaHeiligers
commented
Feb 15, 2024
| @@ -177,7 +179,7 @@ export interface SavedObjectsType<Attributes = any> { | |||
| modelVersions?: SavedObjectsModelVersionMap | SavedObjectsModelVersionMapProvider; | |||
|
|
|||
| /** | |||
| * Allows to opt-in to the new model version API. | |||
| * Allows to opt-in to the model version API. | |||
There was a problem hiding this comment.
The model version API won't be "new" for long.
jloleysens
approved these changes
Feb 15, 2024
There was a problem hiding this comment.
Great work @TinaHeiligers ! I did not do a deep review of the documented content also not very familiar with all asciidoc features but this LGTM! Thanks for addressing this issue!
docs/developer/architecture/core/saved-objects-service.asciidoc
Outdated
Show resolved
Hide resolved
| modelVersions: { ... }, | ||
| // ...other optional properties | ||
| }; | ||
| } |
There was a problem hiding this comment.
If above suggestion is accepted, also do this and de-indent content
Suggested change
| } |
💚 Build Succeeded
Metrics [docs]Unknown metric groupsReferences to deprecated APIs
History
To update your PR or re-run it, just comment with: |
1 task
fkanout
pushed a commit
to fkanout/kibana
that referenced
this pull request
Mar 4, 2024
…rsions (elastic#176970) fix elastic#176776 Saved objects `modelVersions` support BWC and ZDT and replace `SavedObjectsType.schemas` and `SavedObjectsType.migrations` properties. This PR marks these two properties as deprecated. The public facing docs have also been updated to the "new" way of implementing saved object changes. ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials
TinaHeiligers
added a commit
that referenced
this pull request
Mar 7, 2024
fix [#178060](#178060) Updates the internal developer docs for transitions to new model versions. The end-user docs were updated in #176970 --------- Co-authored-by: Jean-Louis Leysens <[email protected]>
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.
fix #176776
Saved objects
modelVersionssupport BWC and ZDT and replaceSavedObjectsType.schemasandSavedObjectsType.migrationsproperties.This PR marks these two properties as deprecated.
The public facing docs have also been updated to the "new" way of implementing saved object changes.
Checklist
Delete any items that are not applicable to this PR.