1 # API Versioning ChangeLog
3 Our API versioning contains an `APIVER` and an `APIAGE`.
4 The `APIAGE` is the number of versions we're backward compatible with. (iow. things got added
5 without breaking anything unaware of it.)
7 Future changes should be documented in here.
11 * a new `rename_volume` method has been added
13 Storage plugins with rename support need to enable
14 the `rename` feature flag; e.g. in the `volume_has_feature` method.
16 * Replace `volume_snapshot_list` with `volume_snapshot_info`:
18 `volume_snapshot_list` was used exclusively by replication and currently, replication is only
19 allowed for the storage type `zfspool`. Thus, no external plugins should be affected by this
20 change and `APIAGE` is *not* reset.
22 `volume_snapshot_info` returns a hash with snapshot names as keys and `id` and `timestamp` data
23 for each snapshot, rather than just an array of snaphsot names like `volume_snapshot_list` did.
25 * Add `blockers` parameter to `volume_rollback_is_possible`:
27 The parameter *can* be used to return a list of snapshots that is currently preventing rollback.
29 * Replace get/update_volume_notes with generic get/update_volume_attribute
31 falling back to the old implementation for notes until we reset APIAGE. the
32 new method optionally also supports querying/setting a protected flag.
34 ## Version 9: (AGE resets to 0):
36 * volume_import_formats gets a new parameter *inserted*:
39 sub($plugin, $scfg, $storeid, $volname, $base_snapshot, $with_snapshots)
41 sub($plugin, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots)
43 This is now the same as `volume_export_formats`.
45 The same goes for calls to `PVE::Storage::volume_import_formats`, which now
46 takes a `$snapshot` parameter in the same place.
48 * $with_snapshots *may* now be an array reference containing an ordered list of
49 snapshots, but *may* also just be a boolean, and the contained list *may* be
50 ignored, so it can still be treated as a boolean.