This policy outlines the rules for versioning the PARS JSON schema, inspired by SchemaVer principles. It categorizes changes as major, minor, or patches, ensuring consistent evolution of the schema.
Versioning follows the SchemaVer format: MODEL-REVISION-ADDITION.
- MODEL: Incremented for breaking schema changes that prevent interaction with historical data. This change will likely require updating software for one or more vendors.
- MINOR (REVISION): Incremented for changes that might limit interaction with some historical data but are not breaking changes. This may require updating software with vendors in certain cases.
- PATCH (ADDITION): Incremented for non-breaking changes compatible with all historical data. This may require updating software with some vendors to enable new functionality, but previous versions will continue to work.
-
Major Changes (MODEL)
- Significant modifications that render the new schema incompatible with previous versions.
- Examples include removing fields or changing field types, adding new required DS files, or other substantial changes.
- Version example:
2-0-0.
-
Minor Changes (REVISION)
- Backward-compatible functionalities that might not work with some historical data.
- Examples include adding new optional fields, adding new optional DS files.
- Version example:
1-1-0.
-
Patches (ADDITION)
- Minor, backward-compatible fixes or changes.
- Examples include adding new optional fields that don’t affect existing data.
- Version example:
1-0-1.
-
Documentation Changes
- Corrections or clarifications in the documentation are not reflected in the version number if the intention of the requirement is not changed. No action will ever be needed by a vendor or contractor in these cases.
- Documentation updates are indicated by a date update on the PDF DID and are included on the releasenotes page.
- Each release is documented on the releasenotes page.
- It includes the version number, release date, and a summary of changes.
- It also details the impact of the changes on existing implementations.