Merge "Update os-agents for Compute v2.1 - describe parameters."

This commit is contained in:
Jenkins 2015-04-06 18:53:59 +00:00 committed by Gerrit Code Review
commit 594fd8dbec
22 changed files with 91 additions and 64 deletions

View File

@ -45,12 +45,14 @@
</section>
<section xml:id="v2.1agents">
<title>Guest agents (os-agents)</title>
<para>Creates, updates, and deletes guest agents. Use guest agents
to access files on the disk, configure networking, or run other
applications or scripts in the guest while it runs. This
hypervisor-specific extension is not currently enabled for KVM.
Use of guest agents is possible only if the underlying service
provider uses the Xen driver.</para>
<para>
Creates, lists, updates, and deletes guest agent builds. Use guest
agents to access files on the disk, configure networking, or run other
applications or scripts in the guest while the agent runs. This
hypervisor-specific extension is not currently enabled for KVM. Use of
guest agents is possible only if the underlying service provider uses
the Xen driver.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-agents-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>

View File

@ -5,6 +5,6 @@
"architecture": "x86",
"version": "8.0",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"url": "http://example.com/path/to/resource"
"url": "xxxxxxxxxxxx"
}
}

View File

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<agent>
<hypervisor>hypervisor</hypervisor>
<os>os</os>
<architecture>x86</architecture>
<version>8.0</version>
<md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
<url>http://example.com/path/to/resource</url>
</agent>

View File

@ -5,7 +5,7 @@
"hypervisor": "hypervisor",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"os": "os",
"url": "http://example.com/path/to/resource",
"url": "xxxxxxxxxxxx",
"version": "8.0"
}
}

View File

@ -1,10 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<agent>
<url>http://example.com/path/to/resource</url>
<hypervisor>hypervisor</hypervisor>
<md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
<version>8.0</version>
<architecture>x86</architecture>
<os>os</os>
<agent_id>1</agent_id>
</agent>

View File

@ -1,6 +1,6 @@
{
"para": {
"url": "http://example.com/path/to/resource",
"agent": {
"url": "xxx://xxxx/xxx/xxx",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"version": "7.0"
}

View File

@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<para>
<version>7.0</version>
<url>http://example.com/path/to/resource</url>
<md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
</para>

View File

@ -1,8 +1,8 @@
{
"agent": {
"agent_id": "1",
"agent_id": 1,
"md5hash": "add6bb58e139be103324d04d82d8f545",
"url": "http://example.com/path/to/resource",
"url": "xxx://xxxx/xxx/xxx",
"version": "7.0"
}
}

View File

@ -1,7 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<agent>
<url>http://example.com/path/to/resource</url>
<version>7.0</version>
<agent_id>1</agent_id>
<md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
</agent>

View File

@ -6,7 +6,7 @@
"hypervisor": "hypervisor",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"os": "os",
"url": "http://example.com/path/to/resource",
"url": "xxxxxxxxxxxx",
"version": "8.0"
}
]

View File

@ -1,4 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<agents>
<agent url="http://example.com/path/to/resource" hypervisor="hypervisor" md5hash="add6bb58e139be103324d04d82d8f545" version="8.0" architecture="x86" os="os" agent_id="1"/>
</agents>

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -9,13 +9,20 @@
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com"
xml:id="os-agents-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="version" type="#VersionDetails" path="//v2.1">
<resource id="os-agents" path="os-agents">
<method href="#agentbuild"/>
<method href="#listbuilds"/>
<resource id="id" path="{id}">
<resource path="{id}" id="agent_id">
<param name="id" style="template"
required="true" type="xsd:int">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The agent ID.</para></wadl:doc>
</param>
<method href="#updatebuild"/>
</resource>
<method href="#deleteBuild"/>
</resource>
</resource>
</resources>
@ -76,6 +83,26 @@
href="../api_samples/os-agents/agent-update-put-req.json"
/>
</wadl:doc>
<param name="url" style="plain"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The URL
associated with the
agent.</para></wadl:doc>
</param>
<param name="md5hash" style="plain"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The MD5 hash.</para></wadl:doc>
</param>
<param name="version" style="plain"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The version.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
@ -86,7 +113,41 @@
href="../api_samples/os-agents/agent-update-put-resp.json"
/>
</wadl:doc>
<param name="agent_id" style="plain"
required="true" type="xsd:int">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The agent ID.</para></wadl:doc>
</param>
<param name="url" style="plain"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The URL
associated with the
agent.</para></wadl:doc>
</param>
<param name="md5hash" style="plain"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The MD5 hash.</para></wadl:doc>
</param>
<param name="version" style="plain"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The version.</para></wadl:doc>
</param>
</representation>
</response>
</method>
<method name="DELETE" id="deleteBuild">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete agent build">
<para role="shortdesc">Deletes an existing agent
build.</para>
</wadl:doc>
<response status="202"/>
</method>
</application>

View File

@ -5,6 +5,6 @@
"architecture": "x86",
"version": "8.0",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"url": "http://example.com/path/to/resource"
"url": "xxxxxxxxxxxx"
}
}

View File

@ -5,5 +5,5 @@
<architecture>x86</architecture>
<version>8.0</version>
<md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
<url>http://example.com/path/to/resource</url>
<url>xxxxxxxxxxxx</url>
</agent>

View File

@ -1,11 +1,11 @@
{
"agent": {
"agent_id": 1,
"agent_id": "1",
"architecture": "x86",
"hypervisor": "hypervisor",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"os": "os",
"url": "http://example.com/path/to/resource",
"url": "xxxxxxxxxxxx",
"version": "8.0"
}
}

View File

@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<agent>
<url>http://example.com/path/to/resource</url>
<url>xxxxxxxxxxxx</url>
<hypervisor>hypervisor</hypervisor>
<md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
<version>8.0</version>

View File

@ -1,6 +1,6 @@
{
"para": {
"url": "http://example.com/path/to/resource",
"url": "xxx://xxxx/xxx/xxx",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"version": "7.0"
}

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<para>
<version>7.0</version>
<url>http://example.com/path/to/resource</url>
<url>xxx://xxxx/xxx/xxx</url>
<md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
</para>

View File

@ -2,7 +2,7 @@
"agent": {
"agent_id": "1",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"url": "http://example.com/path/to/resource",
"url": "xxx://xxxx/xxx/xxx",
"version": "7.0"
}
}

View File

@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<agent>
<url>http://example.com/path/to/resource</url>
<url>xxx://xxxx/xxx/xxx</url>
<version>7.0</version>
<agent_id>1</agent_id>
<md5hash>add6bb58e139be103324d04d82d8f545</md5hash>

View File

@ -1,12 +1,12 @@
{
"agents": [
{
"agent_id": 1,
"agent_id": "1",
"architecture": "x86",
"hypervisor": "hypervisor",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"os": "os",
"url": "http://example.com/path/to/resource",
"url": "xxxxxxxxxxxx",
"version": "8.0"
}
]

View File

@ -1,4 +1,4 @@
<?xml version='1.0' encoding='UTF-8'?>
<agents>
<agent url="http://example.com/path/to/resource" hypervisor="hypervisor" md5hash="add6bb58e139be103324d04d82d8f545" version="8.0" architecture="x86" os="os" agent_id="1"/>
<agent url="xxxxxxxxxxxx" hypervisor="hypervisor" md5hash="add6bb58e139be103324d04d82d8f545" version="8.0" architecture="x86" os="os" agent_id="1"/>
</agents>