@vitessce/schemas

3.4.6 • Public • Published

How to add a new schema version

The following checklist can be used when adding a new schema version.

  • Upgrade function: Each schema version must be accompanied by an upgrade function that facilitates automatically upgrading configs from the directly preceding schema version.
  • Zod schema: Each schema version must be accompanied by a Zod schema.
  • Config version meta-information: in previous-config-meta.ts
    • Set the newly-defined schema as the value of latestConfigSchema.
    • Add the newly-defined schema type to the AnyVersionConfig union type.
    • Append the newly-defined schema and upgrade function to the SCHEMA_HANDLERS array.
  • Update the list of config versions on the View Configs via JSON documentation page.

If the reasoning for the new version is NOT for only coordination type or behavioral changes:

  • Update the schema constructed by buildConfigSchema to match the "generic" (i.e., non-plugin-specific) schema in latestConfigSchema.

Readme

Keywords

none

Package Sidebar

Install

npm i @vitessce/schemas

Homepage

vitessce.io

Weekly Downloads

253

Version

3.4.6

License

MIT

Unpacked Size

720 kB

Total Files

56

Last publish

Collaborators

  • keller-mark