openstack/python-openstackclient
Code Issues Proposed changes
python-openstackclient/doc/source/backwards-incompatible.rst
TerryHowe b3335b3474 Do not set default versions in parsed args 
Setting default versions in parsed args makes it so OCC
cannot tell if the argument was parsed, an environment
variable was set or it is just defaulted.  In order to
set api versions from OCC, it will have to be defaulted
after processing OCC.

Closes-Bug: #1453229
Change-Id: I4d065919397b783f3bdd4022c986c0234a7a16e6
2015-07-18 06:28:09 -06:00

4.1 KiB
Raw Blame History

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.

  1. Plugin interface change for default API versions

Previously, the default version was set in the parsed arguments, but this makes it impossible to tell what has been passed in at the command line, set in an environment variable or is just the default. Now, the module should have a DEFAULT_API_VERSION that contains the value and it will be set after command line argument, environment and OCC file processing.

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