From 5b9a51af72d56159512b17380b5e88650edb4519 Mon Sep 17 00:00:00 2001 From: jichenjc Date: Mon, 25 Apr 2016 03:44:57 +0800 Subject: [PATCH] Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29 --- api-ref/source/os-hypervisors.inc | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/api-ref/source/os-hypervisors.inc b/api-ref/source/os-hypervisors.inc index f2e6417b8829..abc55ffe2ed4 100644 --- a/api-ref/source/os-hypervisors.inc +++ b/api-ref/source/os-hypervisors.inc @@ -1,5 +1,4 @@ .. -*- rst -*- -.. needs:method_verification .. needs:parameter_verification .. needs:example_verification .. needs:body_verification @@ -19,10 +18,11 @@ List Hypervisors Lists hypervisors. +Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + Normal response codes: 200 -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403) Request ------- @@ -46,6 +46,8 @@ List Hypervisors Details Lists hypervisors details. +Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) @@ -72,10 +74,11 @@ Show Hypervisor Statistics Shows summary statistics for all 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 the ``policy.json`` file. + Normal response codes: 200 -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403) Request ------- @@ -99,10 +102,12 @@ Show Hypervisor Details Shows details for a hypervisor. +Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions thro +ugh the ``policy.json`` file. + Normal response codes: 200 -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) Request ------- @@ -127,10 +132,12 @@ Show Hypervisor Uptime Shows the uptime for a hypervisor. +Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions thro +ugh the ``policy.json`` file. + Normal response codes: 200 -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), NotImplemented(501) Request ------- @@ -155,6 +162,9 @@ Search Hypervisor Search hypervisor by given hypervisor id. +Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions thro +ugh the ``policy.json`` file. + Normal response code: 200 Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) @@ -182,6 +192,9 @@ List Hypervisor Servers List all servers belong to given hypervisor. +Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions thro +ugh the ``policy.json`` file. + Normal response code: 200 Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)