python-openstackclient/doc/source/backwards-incompatible.rst
TerryHowe 62bb88f621 Security group rule delete broken
Nova client was changed to take a rule id for security group
rule delete.

https://github.com/openstack/python-novaclient/blob/master/novaclient/v2/security_group_rules.py#L72

Change-Id: I0a69f3f196a36f267ee85a651b09aa8d3c328121
Closes-Bug: #1450872
2015-05-07 13:10:06 -06:00

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

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