summaryrefslogtreecommitdiff
path: root/api-ref/source/os-agents.inc
diff options
context:
space:
mode:
authorHe Jie Xu <hejie.xu@intel.com>2016-04-19 21:02:15 +0800
committerHe Jie Xu <hejie.xu@intel.com>2016-04-20 10:23:47 +0800
commit469771a3b5a342c9216a47b1f086d328d3f1adb6 (patch)
tree15c35fa4cf5b30ff5b8fe527b6385081fbc8aace /api-ref/source/os-agents.inc
parent8e811ec83885412aa205e8937cbc4df1207aad5d (diff)
downloadnova-469771a3b5a342c9216a47b1f086d328d3f1adb6.tar.gz
Fix the parameters for os-agents API
* Add notes for API bug: update return string type's agent id * Fix the parameters for create agent * Fix the description of agent id in the update url. Part of bp:api-ref-in-rst Change-Id: I5c102ef8a08123089ec4a85dde5716eda12fb8c7
Diffstat (limited to 'api-ref/source/os-agents.inc')
-rw-r--r--api-ref/source/os-agents.inc14
1 files changed, 12 insertions, 2 deletions
diff --git a/api-ref/source/os-agents.inc b/api-ref/source/os-agents.inc
index 0859870aab..4e60d6fe12 100644
--- a/api-ref/source/os-agents.inc
+++ b/api-ref/source/os-agents.inc
@@ -29,7 +29,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- - hypervisor: OS-EXT-SRV-ATTR:hypervisor_hostname
+ - hypervisor: hypervisor
- architecture: architecture
- os: os
- url: url
@@ -44,6 +44,16 @@ Request
Response
--------
+.. rest_parameters:: parameters.yaml
+
+ - hypervisor: hypervisor
+ - architecture: architecture
+ - os: os
+ - url: url
+ - md5hash: md5hash
+ - version: version
+ - agent_id: agent_id
+
**Example Create Agent Build: JSON response**
.. literalinclude:: ../../doc/api_samples/os-agents/agent-post-resp.json
@@ -137,7 +147,7 @@ Response
.. rest_parameters:: parameters.yaml
- - agent_id: agent_id
+ - agent_id: agent_id_str
- url: url
- md5hash: md5hash
- version: version