From e4ae7e91dcc079b70c811eff5b1e6fdb42fc7be6 Mon Sep 17 00:00:00 2001 From: jichenjc Date: Wed, 21 Dec 2016 02:35:18 +0800 Subject: [PATCH] correct misleading wording this schema tells us host is required https://github.com/openstack/nova/blob/master/nova/api/ openstack/compute/schemas/migrate_server.py#L33 and also param say it's required, but the doc says 'if you omit' will misleading user ,actually, user can't omit it, they need to input null to let scheduler decide Implements: blueprint api-ref-in-rst-ocata Change-Id: I2661c85f32eff8e199856635a4c40a494a5decb6 --- api-ref/source/parameters.yaml | 2 +- api-ref/source/servers-admin-action.inc | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index e9a3befb10ce..e30e6827d4da 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -2149,7 +2149,7 @@ host_memory_mb: type: string host_migration: description: | - The host to which to migrate the server. If you omit this parameter, the scheduler + The host to which to migrate the server. If this parameter is ``None``, the scheduler chooses a host. in: body required: true diff --git a/api-ref/source/servers-admin-action.inc b/api-ref/source/servers-admin-action.inc index f3508fee7330..cef4771c29fd 100644 --- a/api-ref/source/servers-admin-action.inc +++ b/api-ref/source/servers-admin-action.inc @@ -145,8 +145,8 @@ Live-migrates a server to a new host without rebooting. Specify the ``os-migrateLive`` action in the request body. -Use the ``host`` parameter to specify the destination host. If you -omit this parameter, the scheduler chooses a host. If a scheduled host +Use the ``host`` parameter to specify the destination host. If +this param is ``null``, the scheduler chooses a host. If a scheduled host is not suitable to do migration, the scheduler tries up to ``migrate_max_retries`` rescheduling attempts.