5
0
mirror of git://git.proxmox.com/git/pve-storage.git synced 2025-01-07 17:18:02 +03:00
pve-storage/ApiChangeLog
Fabian Ebner a799f7529b bump APIVER and APIAGE
Added blockers parameter to volume_rollback_is_possible.
Replaced volume_snapshot_list with volume_snapshot_info.

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2021-11-08 10:35:53 +01:00

42 lines
1.6 KiB
Plaintext

# API Versioning ChangeLog
Our API versioning contains an `APIVER` and an `APIAGE`.
The `APIAGE` is the number of versions we're backward compatible with. (iow. things got added
without breaking anything unaware of it.)
Future changes should be documented in here.
## Version 10:
* Replace `volume_snapshot_list` with `volume_snapshot_info`:
`volume_snapshot_list` was used exclusively by replication and currently, replication is only
allowed for the storage type `zfspool`. Thus, no external plugins should be affected by this
change and `APIAGE` is *not* reset.
`volume_snapshot_info` returns a hash with snapshot names as keys and `id` and `timestamp` data
for each snapshot, rather than just an array of snaphsot names like `volume_snapshot_list` did.
* Add `blockers` parameter to `volume_rollback_is_possible`:
The parameter *can* be used to return a list of snapshots that is currently preventing rollback.
## Version 9: (AGE resets to 0):
* volume_import_formats gets a new parameter *inserted*:
Old signature:
sub($plugin, $scfg, $storeid, $volname, $base_snapshot, $with_snapshots)
New signature:
sub($plugin, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots)
This is now the same as `volume_export_formats`.
The same goes for calls to `PVE::Storage::volume_import_formats`, which now
takes a `$snapshot` parameter in the same place.
* $with_snapshots *may* now be an array reference containing an ordered list of
snapshots, but *may* also just be a boolean, and the contained list *may* be
ignored, so it can still be treated as a boolean.