compute: 'server volume update' -> 'server volume set'

stephenfin · stephenfin · commit e0577e7ebe35 · 2022-12-15T18:22:08.000Z
We use 'set', not 'update', in command names. An alias is provided.

Change-Id: I7864599e06df055999b975aabf101611cd482753
Signed-off-by: Stephen Finucane &lt;sfinucan@redhat.com&gt;
diff --git a/openstackclient/compute/v2/server.py b/openstackclient/compute/v2/server.py
@@ -3907,9 +3907,7 @@ def take_action(self, parsed_args):
 
 # TODO(stephenfin): Remove in OSC 7.0
 class MigrateConfirm(ResizeConfirm):
-    _description = _("""DEPRECATED: Confirm server migration.
-
-Use 'server migration confirm' instead.""")
+    _description = _("DEPRECATED: Use 'server migration confirm' instead.")
 
     def take_action(self, parsed_args):
         msg = _(
@@ -3955,9 +3953,7 @@ def take_action(self, parsed_args):
 
 # TODO(stephenfin): Remove in OSC 7.0
 class MigrateRevert(ResizeRevert):
-    _description = _("""Revert server migration.
-
-Use 'server migration revert' instead.""")
+    _description = _("DEPRECATED: Use 'server migration revert' instead.")
 
     def take_action(self, parsed_args):
         msg = _(
diff --git a/openstackclient/compute/v2/server_volume.py b/openstackclient/compute/v2/server_volume.py
@@ -78,7 +78,7 @@ def take_action(self, parsed_args):
         )
 
 
-class UpdateServerVolume(command.Command):
+class SetServerVolume(command.Command):
     """Update a volume attachment on the server."""
 
     def get_parser(self, prog_name):
@@ -140,3 +140,8 @@ def take_action(self, parsed_args):
                 volume,
                 delete_on_termination=parsed_args.delete_on_termination,
             )
+
+
+# Legacy alias
+class UpdateServerVolume(SetServerVolume):
+    """DEPRECATED: Use 'server volume set' instead."""
diff --git a/releasenotes/notes/rename-server-volume-update-to-server-volume-set-833f1730a9bf6169.yaml b/releasenotes/notes/rename-server-volume-update-to-server-volume-set-833f1730a9bf6169.yaml
@@ -0,0 +1,6 @@
+---
+upgrade:
+  - |
+    The ``server volume update`` command has been renamed to ``server volume
+    set`` to better match other commands in OSC. An alias is provided for
+    backwards compatibility.
diff --git a/setup.cfg b/setup.cfg
@@ -159,6 +159,7 @@ openstack.compute.v2 =
     server_migration_show = openstackclient.compute.v2.server_migration:ShowMigration
 
     server_volume_list = openstackclient.compute.v2.server_volume:ListServerVolume
+    server_volume_set = openstackclient.compute.v2.server_volume:SetServerVolume
     server_volume_update = openstackclient.compute.v2.server_volume:UpdateServerVolume
 
     usage_list = openstackclient.compute.v2.usage:ListUsage

Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ def take_action(self, parsed_args):`
`78`	`78`	`)`
`79`	`79`
`80`	`80`
`81`		`-class UpdateServerVolume(command.Command):`
	`81`	`+class SetServerVolume(command.Command):`
`82`	`82`	`"""Update a volume attachment on the server."""`
`83`	`83`
`84`	`84`	`def get_parser(self, prog_name):`
`@@ -140,3 +140,8 @@ def take_action(self, parsed_args):`
`140`	`140`	`volume,`
`141`	`141`	`delete_on_termination=parsed_args.delete_on_termination,`
`142`	`142`	`)`
	`143`	`+`
	`144`	`+`
	`145`	`+# Legacy alias`
	`146`	`+class UpdateServerVolume(SetServerVolume):`
	`147`	`+ """DEPRECATED: Use 'server volume set' instead."""`