Instance Property
schemaVersion
The current version of the render node schema.
var schemaVersion: SemanticVersion
Discussion
The schema version describes the compatibility of a client with a render node value. Clients should be able to decode render node values of the same major version, but are not guaranteed to be able to decode values of other major versions. For example, a client that supports render node 2.5.0 should be able to process any render node of version greater than or equal to 2.0.0 and less than 3.0.0 with no regressions, ignoring new fields in render nodes of version greater than 2.5.0.
The components should be incremented as follows:
The major component should be incremented when introducing a change that prevents clients from processing older render node values, for example when creating a new required property.
The minor component should be incremented when introducing a change that’s compatible with older values, for example when creating a new optional property.
The pre-release component can be used during development to indicate a new version without incrementing the major or minor components. When creating a DocC release, the render node version should not have a pre-release component.
Note
The patch value is currently unused and always set to 0.