[PATCH manager 3/3] api: backup: deprecate starttime and dow in create/update parameter schema

[Lukas Wagner <l.wagner@proxmox.com>]

When creating and updating backup jobs, the both parameters will be
supported until further notice -- we only really should remove them in a
major update -- but it definitely makes sense to mark them as deprecated
in the parameter schema and document that these will be automatically
translated into a matching 'schedule'.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 PVE/API2/Backup.pm | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/PVE/API2/Backup.pm b/PVE/API2/Backup.pm
index 0683748e..3bd85593 100644
--- a/PVE/API2/Backup.pm
+++ b/PVE/API2/Backup.pm
@@ -269,18 +269,22 @@ __PACKAGE__->register_method({
                 maxLength => 128,
                 optional => 1,
             },
+            # FIXME: MAJOR VERSION: Drop this deprecated parameter.
             starttime => {
                 type => 'string',
-                description => "Job Start time.",
+                description => "Deprecated: Use 'schedule' instead. Job Start time."
+                    . " 'starttime' and 'dow' will be converted into 'schedule' if used.",
                 pattern => '\d{1,2}:\d{1,2}',
                 typetext => 'HH:MM',
                 optional => 1,
             },
+            # FIXME: MAJOR VERSION: Drop this deprecated parameter.
             dow => {
                 type => 'string',
                 format => 'pve-day-of-week-list',
                 optional => 1,
-                description => "Day of week selection.",
+                description => "Deprecated: Use 'schedule' instead. Day of week selection."
+                    . " 'starttime' and 'dow' will be converted into 'schedule' if used.",
                 requires => 'starttime',
                 default => ALL_DAYS,
             },
@@ -497,19 +501,23 @@ __PACKAGE__->register_method({
                 maxLength => 128,
                 optional => 1,
             },
+            # FIXME: MAJOR VERSION: Drop this deprecated parameter.
             starttime => {
                 type => 'string',
-                description => "Job Start time.",
+                description => "Deprecated: Use 'schedule' instead. Job Start time."
+                    . " 'starttime' and 'dow' will be converted into 'schedule' if used.",
                 pattern => '\d{1,2}:\d{1,2}',
                 typetext => 'HH:MM',
                 optional => 1,
             },
+            # FIXME: MAJOR VERSION: Drop this deprecated parameter.
             dow => {
                 type => 'string',
                 format => 'pve-day-of-week-list',
                 optional => 1,
                 requires => 'starttime',
-                description => "Day of week selection.",
+                description => "Deprecated: Use 'schedule' instead. Day of week selection."
+                    . " 'starttime' and 'dow' will be converted into 'schedule' if used.",
             },
             delete => {
                 type => 'string',
-- 
2.47.3