summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2018-06-28 14:00:49 -0400
committerMatt Riedemann <mriedem.os@gmail.com>2018-06-28 14:00:49 -0400
commit7e8c55fa1bbc5f44b9233602786c22d6019eef22 (patch)
tree67759404e9ca73fe8aee3fabeac7d08f1ce0ac10
parent3493948d13aadd1a329b37eb8fafb731b1f5c6a7 (diff)
downloadpython-openstackclient-7e8c55fa1bbc5f44b9233602786c22d6019eef22.tar.gz
Fix docs from I0dc80bee3ba6ff4ec8cc3fc113b6de7807e0bf2a
The CLI usage docs should mention the microversion restriction for creating a flavor with a description and setting a description on a flavor. Also, the release note talks about setting the server description on the flavor commands (wrong resource). Change-Id: I93af3da9a0be62395a1c719fd1dcbfd2b669580d Story: 2002196 Task: 22607
-rw-r--r--doc/source/cli/command-objects/flavor.rst6
-rw-r--r--releasenotes/notes/flavor-add-description-b618abd4a7fb6545.yaml6
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst
index 2d946de3..f22463b7 100644
--- a/doc/source/cli/command-objects/flavor.rst
+++ b/doc/source/cli/command-objects/flavor.rst
@@ -79,7 +79,8 @@ Create new flavor
.. option:: --description <description>
- Description to add for this flavor
+ Description to add for this flavor. Only available starting with
+ ``--os-compute-api-version 2.55``.
.. _flavor_create-flavor-name:
.. describe:: <flavor-name>
@@ -176,7 +177,8 @@ Set flavor properties
.. option:: --description <description>
- Set description to this flavor
+ Description to set for this flavor. Only available starting with
+ ``--os-compute-api-version 2.55``.
.. describe:: <flavor>
diff --git a/releasenotes/notes/flavor-add-description-b618abd4a7fb6545.yaml b/releasenotes/notes/flavor-add-description-b618abd4a7fb6545.yaml
index f148175f..0d22354f 100644
--- a/releasenotes/notes/flavor-add-description-b618abd4a7fb6545.yaml
+++ b/releasenotes/notes/flavor-add-description-b618abd4a7fb6545.yaml
@@ -1,6 +1,8 @@
---
features:
- Add ``--description`` option to ``flavor set`` command to update the
- description of the server.
+ description of the flavor. Only available starting with
+ ``--os-compute-api-version 2.55``.
- Add ``--description`` option to ``flavor create`` command to set the
- description of the server.
+ description of the flavor. Only available starting with
+ ``--os-compute-api-version 2.55``.