From 298565a762f6e606d0f5c3004a039378322b8ca2 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Wed, 14 Jun 2017 11:28:56 -0400 Subject: [PATCH] api-ref: cleanup PUT /os-hypervisors/statistics docs There are two changes here: 1. It is important to state that this API only returns a summary of compute node/service statistics for *enabled* nova-compute services. The DB API query filters out disabled compute services. 2. Fixes a typo in the description of the hypervisor_statistics parameter. Change-Id: Iee28147b701ab42eb07d344cd2f4cb157b74b2f2 --- api-ref/source/os-hypervisors.inc | 2 +- api-ref/source/parameters.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api-ref/source/os-hypervisors.inc b/api-ref/source/os-hypervisors.inc index 329d465e82..b1346c4627 100644 --- a/api-ref/source/os-hypervisors.inc +++ b/api-ref/source/os-hypervisors.inc @@ -116,7 +116,7 @@ Show Hypervisor Statistics .. rest_method:: GET /os-hypervisors/statistics -Shows summary statistics for all hypervisors over all compute nodes. +Shows summary statistics for all enabled hypervisors over all compute nodes. Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 11efb2c3b0..f412fa01b8 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -2823,7 +2823,7 @@ hypervisor_state: type: string hypervisor_statistics: description: | - The object of the hypervisors' statics. + The hypervisors statistics summary object. in: body required: true type: object