python-openstackclient/doc/source/backwards-incompatible.rst
TerryHowe 2d4a737160 Remove the --dhcp option to network list
The --dhcp option lists agents, not networks.  This does not make
a lot of sense.  Another command should be created to list agents.

BackwardsIncompatibleImpact
Closes-Bug: #1472613

Change-Id: I5ecfe3fc046a07eb64a4dabd41dbd99de7c2215f
2015-07-08 11:21:41 -06:00

3.5 KiB

Backwards Incompatible Changes

Despite our best efforts, sometimes the OpenStackClient team may introduce a backwards incompatible change. For user convenience we are tracking any such changes here (as of the 1.0.0 release).

Should positional arguments for a command need to change, the OpenStackClient team attempts to make the transition as painless as possible. Look for deprecation warnings that indicate the new commands (or options) to use.

List of Backwards Incompatible Changes

  1. Rename command openstack project usage list

The project part of the command was pointless.

  1. <type> should not be optional for command openstack service create

Previously, the command was openstack service create <name> --type <type>, whereas now it is: openstack service create <type> --name <name> This bug also affected python-keystoneclient, and keystone.

  1. Command openstack security group rule delete now requires rule id

Previously, the command was openstack security group rule delete --proto <proto> [--src-ip <ip-address> --dst-port <port-range>] <group>, whereas now it is: openstack security group rule delete <rule>.

  1. Command openstack image create does not update already existing image

Previously, the image create command updated already existing image if it had same name. It disabled possibility to create multiple images with same name and lead to potentially unwanted update of existing images by image create command. Now, update code was moved from create action to set action.

  1. Command openstack network list --dhcp has been removed

The --dhcp option to network list is not a logical use case of listing networks, it lists agents. Another command should be added in the future to provide this functionality. It is highly unlikely anyone uses this feature as we don't support any other agent commands. Use neutron dhcp-agent-list-hosting-net command instead.

For Developers

If introducing a backwards incompatible change, then add the tag: BackwardsIncompatibleImpact to your git commit message, and if possible, update this file.

To review all changes that are affected, use the following query:

https://review.openstack.org/#/q/project:openstack/python-openstackclient+AND+message:BackwardsIncompatibleImpact,n,z