The following checklist can be used when adding a new schema version.
npm install @vitessce/schemasThe 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.
- Define this in previous-config-upgraders.ts
- __Zod schema__: Each schema version must be accompanied by a Zod schema.
- Define this in previous-config-schemas.ts
- Where possible, .extend from the previous 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.
buildConfigSchema to match the "generic" (i.e., non-plugin-specific) schema in latestConfigSchema.