Note
Due to a technical error, this post is being announced after the changes in Phase 1 were issued.
Overview
When first designing Alloy, we anticipated the need for an item setting that would allow versioning. With this setting enabled, each change to the item would create a new version of the item with only the most recent item being visible in the application. While we still believe this function may hold value in the future, maintaining the feature in the application offers very little benefit over the item audit logs. Instead, the item versions consume storage space unnecessarily when enabled on designs.
We have therefore taken the decision to remove item versioning for the time being.
Who will this affect?
The change to remove item versioning will not impact the functionality within the system and is being made to improve performance for customers with large numbers of items.
This work will mark the properties and endpoints marked as Obsolete to be removed at a later date. If this can cause a problem for API users, we urge you to take action during the time provided before removal as any integrations relying on obsolete properties may cease to function.
Phase 1
Details
Both DesignWebModel and DesignInterfaceWebModel will not have the versioned property being returned anymore. It was already advertised as optional in the response and it is thus not meant to cause any problem.
The start and end properties ofItemWebModel and ReconstructedItemWebModel are now obsolete and will always return respectively 0000-01-01T00:00:00Z and 9999-12-31T12:59:59Z.
The DesignEditWebRequestModel and DesignCreateWebRequestModel will not accept the versioned property anymore. If the property is passed, it will be ignored.
The ReconstructedItemDeltaWebModel optional properties start and end will not be returned anymore.
The GET api/item-version/{itemId} and the GET api/item-version/item/{id} are now obsolete and will be removed as part of phase 2.
Phase 2
The start and end properties of ItemWebModeland ReconstructedItemWebModel that were obsoleted during phase 1 will be removed.
The GET api/item-version/{itemId} and the GET api/item-version/item/{id} that were obsoleted during phase 1 will be removed.
Phase 1 Expected Release Date
3rd September 2021