|
| 1 | +============================== |
| 2 | +Backwards Incompatible Changes |
| 3 | +============================== |
| 4 | + |
| 5 | +Despite our best efforts, sometimes the OpenStackClient team may introduce a |
| 6 | +backwards incompatible change. For user convenience we are tracking any such |
| 7 | +changes here (as of the 1.0.0 release). |
| 8 | + |
| 9 | +Should positional arguments for a command need to change, the OpenStackClient |
| 10 | +team attempts to make the transition as painless as possible. Look for |
| 11 | +deprecation warnings that indicate the new commands (or options) to use. |
| 12 | + |
| 13 | +List of Backwards Incompatible Changes |
| 14 | +====================================== |
| 15 | + |
| 16 | +1. Rename command `openstack project usage list` |
| 17 | + |
| 18 | + The `project` part of the command was pointless. |
| 19 | + |
| 20 | + * In favor of: `openstack usage list` instead. |
| 21 | + * As of: 1.0.2 |
| 22 | + * Removed in: TBD |
| 23 | + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1406654 |
| 24 | + * Commit: https://review.openstack.org/#/c/147379/ |
| 25 | + |
| 26 | +2. <type> should not be optional for command `openstack service create` |
| 27 | + |
| 28 | + Previously, the command was `openstack service create <name> --type <type>`, |
| 29 | + whereas now it is: `openstack service create <type> --name <name>` |
| 30 | + This bug also affected python-keystoneclient, and keystone. |
| 31 | + |
| 32 | + * In favor of: making <type> a positional argument. |
| 33 | + * As of: 1.0.2 |
| 34 | + * Removed in: TBD |
| 35 | + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1404073 |
| 36 | + * Commit: https://review.openstack.org/#/c/143242/ |
| 37 | + |
| 38 | +For Developers |
| 39 | +============== |
| 40 | + |
| 41 | +If introducing a backwards incompatible change, then add the tag: |
| 42 | +``BackwardsIncompatibleImpact`` to your git commit message, and if possible, |
| 43 | +update this file. |
| 44 | + |
| 45 | +To review all changes that are affected, use the following query: |
| 46 | + |
| 47 | +https://review.openstack.org/#/q/project:openstack/python-openstackclient+AND+message:BackwardsIncompatibleImpact,n,z |
0 commit comments