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

DataViews: Preparation for making the API stable. #67274

Open
youknowriad opened this issue Nov 25, 2024 · 1 comment
Open

DataViews: Preparation for making the API stable. #67274

youknowriad opened this issue Nov 25, 2024 · 1 comment
Labels
[Feature] DataViews Work surrounding upgrading and evolving views in the site editor and beyond [Type] Enhancement A suggestion for improvement.

Comments

@youknowriad
Copy link
Contributor

youknowriad commented Nov 25, 2024

In order to be able to stabilize the DataViews package and APIs, we need to work on versioning the different configuration objects that live in that package. This doesn't mean we'll be stabilizing the package soon but at least we'll be ready to do so when we decide that it's ready.

These are the properties that need to support apiVersion and migrations:

  • view config in DataViews
  • fields config in both DataViews and DataForm (same config)
  • form config in DataForm
  • action config in DataViews

For each of these we need to:

  • Add an apiVersion key to the objects (defaulting to 1 if absent)
  • Build a migration framework that normalizes the upgrades the configs to the latest version at the entry level of both DataViews and DataForm

One thing we should avoid for the initialization stable release is to offer any public selectors or accessors for view, form, fields and actions. This is to avoid third-party developers assuming a certain shape for these objects while the format itself can evolve over time because of the apiVersion key.

@youknowriad youknowriad added [Feature] DataViews Work surrounding upgrading and evolving views in the site editor and beyond [Type] Enhancement A suggestion for improvement. labels Nov 25, 2024
@youknowriad
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] DataViews Work surrounding upgrading and evolving views in the site editor and beyond [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

1 participant