From fb3d6afc629f722cadb0b3724fb325208d29ce6a Mon Sep 17 00:00:00 2001
From: ForestLee <lichl@hotmail.com>
Date: Thu, 4 May 2017 11:57:49 +0800
Subject: [PATCH] update the description of hypervisor statistics response

The description of hypervisor statistics response was not for one
hypervisor, but all hypervisors. So I will modify the description
from "this hypervisor" to "all hypervisors".

Change-Id: I5b92732a9044e3ce4b18568b8b37f3e6ffc2c929
Closes-Bug: #1687871
---
 api-ref/source/os-hypervisors.inc | 18 +++++------
 api-ref/source/parameters.yaml    | 54 +++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+), 9 deletions(-)

diff --git a/api-ref/source/os-hypervisors.inc b/api-ref/source/os-hypervisors.inc
index 5309bbdf0243..b6e661f85996 100644
--- a/api-ref/source/os-hypervisors.inc
+++ b/api-ref/source/os-hypervisors.inc
@@ -159,16 +159,16 @@ Response
   - hypervisor_statistics: hypervisor_statistics
   - count: hypervisor_count
   - current_workload: current_workload
-  - disk_available_least: disk_available_least
-  - free_disk_gb: hypervisor_free_disk_gb
-  - free_ram_mb: free_ram_mb
-  - local_gb: local_gb
-  - local_gb_used: local_gb_used
-  - memory_mb: memory_mb
-  - memory_mb_used: memory_mb_used
+  - disk_available_least: disk_available_least_total
+  - free_disk_gb: hypervisor_free_disk_gb_total
+  - free_ram_mb: free_ram_mb_total
+  - local_gb: local_gb_total
+  - local_gb_used: local_gb_used_total
+  - memory_mb: memory_mb_total
+  - memory_mb_used: memory_mb_used_total
   - running_vms: running_vms_total
-  - vcpus: hypervisor_vcpus
-  - vcpus_used: hypervisor_vcpus_used
+  - vcpus: hypervisor_vcpus_total
+  - vcpus_used: hypervisor_vcpus_used_total
 
 **Example Show Hypervisor Statistics: JSON response**
 
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 16ede5782ee7..f03b3e4a9eae 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -2076,6 +2076,12 @@ disk_available_least:
   in: body
   required: true
   type: integer
+disk_available_least_total:
+  description: |
+    The actual free disk on all hypervisors(in GB).
+  in: body
+  required: true
+  type: integer
 disk_bus:
   description: |
     Disk bus type, some hypervisors (currently only libvirt) support
@@ -2889,6 +2895,12 @@ free_ram_mb:
   in: body
   required: true
   type: integer
+free_ram_mb_total:
+  description: |
+    The free RAM on all hypervisors(in MB).
+  in: body
+  required: true
+  type: integer
 from_port:
   description: |
     The port at start of range.
@@ -3159,6 +3171,12 @@ hypervisor_free_disk_gb:
   in: body
   required: true
   type: integer
+hypervisor_free_disk_gb_total:
+  description: |
+    The free disk remaining on all hypervisors(in GB).
+  in: body
+  required: true
+  type: integer
 hypervisor_hostname:
   description: |
     The hypervisor host name provided by the Nova virt driver. For the Ironic driver,
@@ -3266,12 +3284,24 @@ hypervisor_vcpus:
   in: body
   required: true
   type: integer
+hypervisor_vcpus_total:
+  description: |
+    The number of vcpu on all hypervisors.
+  in: body
+  required: true
+  type: integer
 hypervisor_vcpus_used:
   description: |
     The number of vcpu used in this hypervisor.
   in: body
   required: true
   type: integer
+hypervisor_vcpus_used_total:
+  description: |
+    The number of vcpu used on all hypervisors.
+  in: body
+  required: true
+  type: integer
 hypervisor_version:
   description: |
     The hypervisor version.
@@ -3870,12 +3900,24 @@ local_gb_simple_tenant_usage_optional:
   in: body
   required: false
   type: integer
+local_gb_total:
+  description: |
+    The disk on all hypervisors(in GB).
+  in: body
+  required: true
+  type: integer
 local_gb_used:
   description: |
     The disk used in this hypervisor(in GB).
   in: body
   required: true
   type: integer
+local_gb_used_total:
+  description: |
+    The disk used on all hypervisors(in GB).
+  in: body
+  required: true
+  type: integer
 lock:
   description: |
     The action to lock a server.
@@ -3956,12 +3998,24 @@ memory_mb_simple_tenant_usage_optional:
   in: body
   required: false
   type: integer
+memory_mb_total:
+  description: |
+    The memory of all hypervisors(in MB).
+  in: body
+  required: true
+  type: integer
 memory_mb_used:
   description: |
     The memory used in this hypervisor(in MB).
   in: body
   required: true
   type: integer
+memory_mb_used_total:
+  description: |
+    The memory used on all hypervisors(in MB).
+  in: body
+  required: true
+  type: integer
 message:
   description: |
     The related error message for when an action fails.