Merge "Added doc support to OS-Flavors Extensions"

This commit is contained in:
Jenkins
2013-03-27 13:55:22 +00:00
committed by Gerrit Code Review
33 changed files with 636 additions and 0 deletions

View File

@@ -249,6 +249,22 @@
href="../wadls/compute-api/src/ext/os-cloudpipe.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavor-access">
<title>Flavor Access</title>
<para>Creates and gets details for private flavors. Also,
lists, adds and removes tenants' access to private flavors.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavor-access.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavor-extra-specs">
<title>Flavor Extra-Specs</title>
<para>Lists, creates, and updates the extra-specs or keys
for a flavor.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavor-extra-specs.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavormanage">
<title>Flavors Create and Delete</title>
<para>Creates and deletes flavors.</para>

View File

@@ -0,0 +1,5 @@
{
"addTenantAccess": {
"tenant": "admin"
}
}

View File

@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<addTenantAccess>
<tenant>admin</tenant>
</addTenantAccess>

View File

@@ -0,0 +1,8 @@
{
"flavor_access": [
{
"flavor_id": "10",
"tenant_id": "admin"
}
]
}

View File

@@ -0,0 +1,4 @@
<?xml version='1.0' encoding='UTF-8'?>
<flavor_access>
<access tenant_id="admin" flavor_id="10"/>
</flavor_access>

View File

@@ -0,0 +1,10 @@
{
"flavor": {
"name": "test_flavor",
"ram": 1024,
"vcpus": 2,
"disk": 10,
"id": "10",
"os-flavor-access:is_public": false
}
}

View File

@@ -0,0 +1,10 @@
<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns="http://docs.openstack.org/compute/api/v1.1"
xmlns:os-flavor-access="http://docs.openstack.org/compute/ext/flavor_access/api/v1.1"
name="test_flavor"
ram="1024"
vcpus="2"
disk="10"
id="10"
os-flavor-access:is_public="False"
/>

View File

@@ -0,0 +1,20 @@
{
"flavor": {
"disk": 10,
"id": "10",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/flavors/10",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/10",
"rel": "bookmark"
}
],
"name": "test_flavor",
"os-flavor-access:is_public": false,
"ram": 1024,
"vcpus": 2
}
}

View File

@@ -0,0 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:os-flavor-access="http://docs.openstack.org/compute/ext/flavor_access/api/v2" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="10" vcpus="2" ram="1024" name="test_flavor" id="10" os-flavor-access:is_public="False">
<atom:link href="http://openstack.example.com/v2/openstack/flavors/10" rel="self"/>
<atom:link href="http://openstack.example.com/openstack/flavors/10" rel="bookmark"/>
</flavor>

View File

@@ -0,0 +1,94 @@
{
"flavors": [
{
"disk": 0,
"id": "1",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny",
"os-flavor-access:is_public": true,
"ram": 512,
"vcpus": 1
},
{
"disk": 20,
"id": "2",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/flavors/2",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/2",
"rel": "bookmark"
}
],
"name": "m1.small",
"os-flavor-access:is_public": true,
"ram": 2048,
"vcpus": 1
},
{
"disk": 40,
"id": "3",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/flavors/3",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/3",
"rel": "bookmark"
}
],
"name": "m1.medium",
"os-flavor-access:is_public": true,
"ram": 4096,
"vcpus": 2
},
{
"disk": 80,
"id": "4",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/flavors/4",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/4",
"rel": "bookmark"
}
],
"name": "m1.large",
"os-flavor-access:is_public": true,
"ram": 8192,
"vcpus": 4
},
{
"disk": 160,
"id": "5",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/flavors/5",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/5",
"rel": "bookmark"
}
],
"name": "m1.xlarge",
"os-flavor-access:is_public": true,
"ram": 16384,
"vcpus": 8
}
]
}

View File

@@ -0,0 +1,23 @@
<?xml version='1.0' encoding='UTF-8'?>
<flavors xmlns:os-flavor-access="http://docs.openstack.org/compute/ext/flavor_access/api/v2" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
<flavor disk="0" vcpus="1" ram="512" name="m1.tiny" id="1" os-flavor-access:is_public="True">
<atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
<atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
</flavor>
<flavor disk="20" vcpus="1" ram="2048" name="m1.small" id="2" os-flavor-access:is_public="True">
<atom:link href="http://openstack.example.com/v2/openstack/flavors/2" rel="self"/>
<atom:link href="http://openstack.example.com/openstack/flavors/2" rel="bookmark"/>
</flavor>
<flavor disk="40" vcpus="2" ram="4096" name="m1.medium" id="3" os-flavor-access:is_public="True">
<atom:link href="http://openstack.example.com/v2/openstack/flavors/3" rel="self"/>
<atom:link href="http://openstack.example.com/openstack/flavors/3" rel="bookmark"/>
</flavor>
<flavor disk="80" vcpus="4" ram="8192" name="m1.large" id="4" os-flavor-access:is_public="True">
<atom:link href="http://openstack.example.com/v2/openstack/flavors/4" rel="self"/>
<atom:link href="http://openstack.example.com/openstack/flavors/4" rel="bookmark"/>
</flavor>
<flavor disk="160" vcpus="8" ram="16384" name="m1.xlarge" id="5" os-flavor-access:is_public="True">
<atom:link href="http://openstack.example.com/v2/openstack/flavors/5" rel="self"/>
<atom:link href="http://openstack.example.com/openstack/flavors/5" rel="bookmark"/>
</flavor>
</flavors>

View File

@@ -0,0 +1,8 @@
{
"flavor_access": [
{
"flavor_id": "10",
"tenant_id": "admin"
}
]
}

View File

@@ -0,0 +1,4 @@
<?xml version='1.0' encoding='UTF-8'?>
<flavor_access>
<access tenant_id="admin" flavor_id="10"/>
</flavor_access>

View File

@@ -0,0 +1,5 @@
{
"removeTenantAccess": {
"tenant": "admin"
}
}

View File

@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<removeTenantAccess>
<tenant>admin</tenant>
</removeTenantAccess>

View File

@@ -0,0 +1,3 @@
{
"flavor_access": []
}

View File

@@ -0,0 +1,2 @@
<?xml version='1.0' encoding='UTF-8'?>
<flavor_access/>

View File

@@ -0,0 +1,20 @@
{
"flavor": {
"disk": 0,
"id": "1",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny",
"os-flavor-access:is_public": true,
"ram": 512,
"vcpus": 1
}
}

View File

@@ -0,0 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:os-flavor-access="http://docs.openstack.org/compute/ext/flavor_access/api/v2" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="0" vcpus="1" ram="512" name="m1.tiny" id="1" os-flavor-access:is_public="True">
<atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
<atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
</flavor>

View File

@@ -0,0 +1,6 @@
{
"extra_specs": {
"key1": "value1",
"key2": "value2"
}
}

View File

@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<extra_specs>
<key1>value1</key1>
<key2>value2</key2>
</extra_specs>

View File

@@ -0,0 +1,6 @@
{
"extra_specs": {
"key1": "value1",
"key2": "value2"
}
}

View File

@@ -0,0 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
<extra_specs>
<key2>value2</key2>
<key1>value1</key1>
</extra_specs>

View File

@@ -0,0 +1,2 @@
<?xml version='1.0' encoding='UTF-8'?>
<extra_spec key="key1">value1</extra_spec>

View File

@@ -0,0 +1,6 @@
{
"extra_specs": {
"key1": "value1",
"key2": "value2"
}
}

View File

@@ -0,0 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
<extra_specs>
<key2>value2</key2>
<key1>value1</key1>
</extra_specs>

View File

@@ -0,0 +1,3 @@
{
"key1": "new_value1"
}

View File

@@ -0,0 +1,2 @@
<?xml version="1.0" encoding="UTF-8"?>
<key1>new_value1</key1>

View File

@@ -0,0 +1,2 @@
<?xml version='1.0' encoding='UTF-8'?>
<extra_spec key="key1">new_value1</extra_spec>

View File

@@ -0,0 +1,196 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., 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">
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}">
<param name="tenant_id" style="template" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The ID for the tenant or account in a multi-tenancy cloud.
</p></doc>
</param>
<resource id="flavors" path="flavors">
<method href="#detailAccess" />
<method href="#createAccess" />
<resource path="{flavor_id}">
<param name="flavor_id" style="template" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The ID of the flavor of interest to you.
</p></doc>
</param>
<method href="#showAccess" />
<resource path="os-flavor-access">
<method href="#listAccess" />
</resource>
<resource path="action">
<method href="#addTenantAccess" />
<method href="#removeTenantAccess" />
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="detailAccess">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Lists all flavors. Includes the access type, which is public or private.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-detail-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-detail-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="createAccess">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Creates a private flavor.
</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-create-req.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-create-req.xml" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-create-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-create-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="showAccess">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Gets the flavor access type, which is either public or private.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-show-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-show-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="listAccess">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Lists tenants with access to the specified private flavor.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-list-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-list-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="addTenantAccess">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Gives the specified tenant access to the specified private flavor.
</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-add-tenant-req.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-add-tenant-req.xml" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-add-tenant-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-add-tenant-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="removeTenantAccess">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Revokes access from the specified tenant for the specified private flavor.
</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-remove-tenant-req.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-remove-tenant-req.xml" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-remove-tenant-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-access/flavor-access-remove-tenant-resp.xml" />
</doc>
</representation>
</response>
</method>
</application>

View File

@@ -0,0 +1,142 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., 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">
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}">
<param name="tenant_id" style="template" type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The ID for the tenant or account in a multi-tenancy cloud.
</p></doc>
</param>
<resource id="flavors" path="flavors">
<resource path="{flavor_id}">
<param name="flavor_id" style="template" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The ID of the flavor of interest to you.
</p></doc>
</param>
<resource path="os-extra_specs">
<method href="#listExtra-specs" />
<method href="#createExtra-specs" />
<method href="#updateExtra-specs" />
<resource path="{key_id}">
<method href="#detailExtra-spec" />
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listExtra-specs">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Lists the extra-specs or keys for the specified flavor.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-list-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-list-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="createExtra-specs">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Creates extra-specs or keys for the specified flavor.
</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-create-req.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-create-req.xml" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-create-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-create-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="updateExtra-specs">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Updates the value of the specified extra-spec or key.
</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-update-req.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-update-req.xml" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-update-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-update-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="detailExtra-spec">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Gets the value of the specified key.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-get-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-flavor-extra-specs/flavor-extra-specs-get-resp.xml" />
</doc>
</representation>
</response>
</method>
</application>