Available from: 2.0.0
Import
import { DesignSystemVersion } from "@supernovaio/sdk"
Properties
- id: The unique identifier of the design system version. This ID provides a distinctive reference to this specific version.
- designSystemId: The identifier of the design system in which this version is created. This association helps maintain a clear link between the design system and its various versions.
- name: The name of the design system version, offering a human-readable label to identify it easily and distinguish it from other versions.
- description: A brief description that provides insights into the purpose, characteristics, or objectives of this particular version of the design system.
- isReadonly: A boolean value indicating whether the version is in read-only mode. In read-only mode, the version cannot be modified, but documentation improvements are still possible. There is only a single version to which you can write, "the draft".
- version: The semantic name of the version, which helps categorize and label it. This field will be null if the version is in draft mode, as draft versions may not have a defined semantic name until finalized. Version follows semantic naming, major.minor.patch.
- changeLog: The change log for the version, documenting any updates, modifications, or improvements made to the design system in this particular version. This field will be null if the version is in draft mode.
- createdAt: The initial date of creation for this version, indicating when it was first established. This timestamp provides historical context for the version's development and evolution.