Add ui_metadata
versioning; other small fixes
#512
Merged
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.
Description
PR to update variety of things:
schema_version
within theui_metadata
field to track schema changes over time. This follows the pattern used in AD for maintaining schema versions of the detector JSON object mappings within the system indices. Over time, if there are substantial UI changes requiring new logic to parse to/from theui_metadata
schema (e.g., some new UI-only construct/idea), we can add such logic, bump the schema version, and add branching logic to parse the legacy schema to the new schema. Future work can be done to optimize/minimize the amount of data and help de-risk BWC concerns and the chances of requiring schema version bumps. For more details on that, see Minimize what's stored inui_metadata
#511 .Testing:
schema_version: 1
entry is added to the UI metadata when inspecting the template JSON after creating workflows made after this changeIssues Resolved
Closes #386
Check List
--signoff
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.