python-openstackclient/doc/source/backwards-incompatible.rst
Steve Martinelli f815b3fe27 Add a doc that dictates backwards incompatible changes
start tracking any changes in a standard format, so users may
have a heads up about any impacts.

Change-Id: Ibc06926a53592e927d11440362cd3598e0d4b2bf
Closes-Bug: 1406470
2015-04-23 23:25:09 -04:00

1.7 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.

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