More parameter cleanup and change to pom to pick up latest snapshot
Change-Id: I3fbb73329736b38d65aef717213c0b7e9ed873e5
This commit is contained in:
annegentle
parent
ca49ee5042
commit
aef56ae791
|
|
@ -35,7 +35,7 @@
|
|||
<listitem><para>Begin API requests by asking for an authorization token from the endpoint your cloud
|
||||
administrator gave you, typically http://hostname:5000/v2.0/tokens. You send your
|
||||
username, password, and what group or account you are with (the "tenant" in auth-speak). </para>
|
||||
<para><programlisting>curl -X 'POST' -v http://thefreecloud.org:5000/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}' -H 'Content-type: application/json'</programlisting></para></listitem>
|
||||
<para><programlisting>curl -X 'POST' -v http://trystack.org:5000/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}' -H 'Content-type: application/json'</programlisting></para></listitem>
|
||||
<listitem><para>The server returns a response in which the 24-hours token is
|
||||
contained. Use that token to send API requests
|
||||
with the X-Auth-Token included as an header
|
||||
|
|
@ -55,15 +55,15 @@
|
|||
<para>For a typical OpenStack deployment running the Identity
|
||||
Service you can request a token with this command in
|
||||
cURL:<programlisting>
|
||||
$ curl -X 'POST' -v http://thefreecloud.org:5000/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}}' -H 'Content-type: application/json'
|
||||
$ curl -X 'POST' -v http://trystack.org:5000/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}}' -H 'Content-type: application/json'
|
||||
</programlisting></para>
|
||||
<para>In return, you should get a 200 OK response with a token in the form of "id": "cd427a33-bb4a-4079-a6d7-0ae148bdeda9" and an expiration date 24 hours from now. Here's what it looks like:</para>
|
||||
<para>
|
||||
<programlisting>
|
||||
* Connected to thefreecloud.org (8.21.28.251) port 5000 (#0)
|
||||
* Connected to trystack.org (8.21.28.251) port 5000 (#0)
|
||||
> POST /v2.0/tokens HTTP/1.1
|
||||
> User-Agent: curl/7.21.4 (universal-apple-darwin11.0) libcurl/7.21.4 OpenSSL/0.9.8r zlib/1.2.5
|
||||
> Host: thefreecloud.org:5000
|
||||
> Host: trystack.org:5000
|
||||
> Accept: */*
|
||||
> Content-type: application/json
|
||||
> Content-Length: 100
|
||||
|
|
@ -75,7 +75,7 @@ $ curl -X 'POST' -v http://thefreecloud.org:5000/v2.0/tokens -d '{"auth":{"passw
|
|||
< Date: Wed, 08 Feb 2012 02:58:56 GMT
|
||||
<
|
||||
{ [data not shown]
|
||||
100 1142 100 1042 100 100 4772 458 --:--:-- --:--:-- --:--:-- 7834* Connection #0 to host thefreecloud.org left intact
|
||||
100 1142 100 1042 100 100 4772 458 --:--:-- --:--:-- --:--:-- 7834* Connection #0 to host trystack.org left intact
|
||||
|
||||
* Closing connection #0
|
||||
{
|
||||
|
|
@ -84,9 +84,9 @@ $ curl -X 'POST' -v http://thefreecloud.org:5000/v2.0/tokens -d '{"auth":{"passw
|
|||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://nova-api.thefreecloud.org:8774/v1.1/1",
|
||||
"internalURL": "http://nova-api.thefreecloud.org:8774/v1.1/1",
|
||||
"publicURL": "http://nova-api.thefreecloud.org:8774/v1.1/1",
|
||||
"adminURL": "http://nova-api.trystack.org:8774/v1.1/1",
|
||||
"internalURL": "http://nova-api.trystack.org:8774/v1.1/1",
|
||||
"publicURL": "http://nova-api.trystack.org:8774/v1.1/1",
|
||||
"region": "RegionOne"
|
||||
}
|
||||
],
|
||||
|
|
@ -96,9 +96,9 @@ $ curl -X 'POST' -v http://thefreecloud.org:5000/v2.0/tokens -d '{"auth":{"passw
|
|||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://glance.thefreecloud.org:9292/v1.1/1",
|
||||
"internalURL": "http://glance.thefreecloud.org:9292/v1.1/1",
|
||||
"publicURL": "http://glance.thefreecloud.org:9292/v1.1/1",
|
||||
"adminURL": "http://glance.trystack.org:9292/v1.1/1",
|
||||
"internalURL": "http://glance.trystack.org:9292/v1.1/1",
|
||||
"publicURL": "http://glance.trystack.org:9292/v1.1/1",
|
||||
"region": "RegionOne"
|
||||
}
|
||||
],
|
||||
|
|
@ -108,9 +108,9 @@ $ curl -X 'POST' -v http://thefreecloud.org:5000/v2.0/tokens -d '{"auth":{"passw
|
|||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://keystone.thefreecloud.org:5001/v2.0",
|
||||
"internalURL": "http://keystone.thefreecloud.org:5000/v2.0",
|
||||
"publicURL": "http://keystone.thefreecloud.org:5000/v2.0",
|
||||
"adminURL": "http://keystone.trystack.org:5001/v2.0",
|
||||
"internalURL": "http://keystone.trystack.org:5000/v2.0",
|
||||
"publicURL": "http://keystone.trystack.org:5000/v2.0",
|
||||
"region": "RegionOne"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ usage: nova [--username USERNAME] [--apikey APIKEY] [--projectid PROJECTID]
|
|||
export NOVA_USERNAME=joecool
|
||||
export NOVA_API_KEY=coolword
|
||||
export NOVA_PROJECT_ID=coolu
|
||||
export NOVA_URL=http://thefreecloud.org:5000/v2.0
|
||||
export NOVA_URL=http://trystack.org:5000/v2.0
|
||||
export NOVA_VERSION=1.1
|
||||
</programlisting>
|
||||
</para>
|
||||
|
|
|
|||
|
|
@ -26,7 +26,10 @@
|
|||
<pluginRepository>
|
||||
<id>rackspace-research</id>
|
||||
<name>Rackspace Research Repository</name>
|
||||
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
|
||||
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
|
||||
<snapshots>
|
||||
<updatePolicy>always</updatePolicy>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
</pluginRepositories>
|
||||
</profile>
|
||||
|
|
|
|||
|
|
@ -38,9 +38,14 @@
|
|||
<chapter xml:id="identity">
|
||||
<title>Identity</title>
|
||||
<para>With the Identity API, you obtain a token that lasts 24 hours so you can gain access to the Compute API. The version of the Identity API is 2.0.</para>
|
||||
<wadl:resources
|
||||
href="identity.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="identity.wadl#tokens" >
|
||||
<wadl:method href="#authenticate"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="identity.wadl#tenants" >
|
||||
<wadl:method href="#listTenants"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</chapter>
|
||||
<chapter xml:id="compute">
|
||||
<title>Compute</title>
|
||||
|
|
@ -49,9 +54,10 @@
|
|||
when needed, resize it larger or smaller, and connect to the
|
||||
server securely through SSH once it is started. The v1.1 API is
|
||||
identical to the v2 API.</para>
|
||||
<wadl:resources
|
||||
href="os-compute-1.1.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
|
||||
<wadl:resources
|
||||
href="os-compute-1.1.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</chapter>
|
||||
<chapter xml:id="files">
|
||||
<title>Image</title>
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@
|
|||
<resource id="Servers" type="#ServerList" path="servers">
|
||||
<method href="#createServer" />
|
||||
<resource path="detail" type="#DetailServerList"/>
|
||||
<resource path="{serverId}">
|
||||
<resource path="{server_id}">
|
||||
<param name="server_id" style="template" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">The UUID for the server of interest to you.</p></doc></param>
|
||||
<method href="#getServer"/>
|
||||
<method href="#updateServer"/>
|
||||
|
|
@ -66,7 +66,7 @@
|
|||
<method href="#createImage"/>
|
||||
</resource>
|
||||
<resource path="ips" type="#Addresses">
|
||||
<resource path="{networkId}" type="#NetworkAddressList">
|
||||
<resource path="{network_id}" type="#NetworkAddressList">
|
||||
<param name="network_id" style="template" type="xsd:string"><doc xml:lang="EN" title="network_id">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">
|
||||
Network address list.
|
||||
|
|
@ -78,7 +78,7 @@
|
|||
</resource>
|
||||
<resource id="Images" type="#ImageList" path="images">
|
||||
<resource path="detail" type="#DetailImageList"/>
|
||||
<resource path="{imageId}">
|
||||
<resource path="{image_id}">
|
||||
<param name="image_id" style="template" type="csapi:UUID">
|
||||
<doc xml:lang="EN" title="image_id">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
|
@ -92,7 +92,7 @@
|
|||
</resource>
|
||||
<resource id="Flavors" type="#FlavorList" path="flavors">
|
||||
<resource path="detail" type="#DetailFlavorList"/>
|
||||
<resource path="{flavorId}">
|
||||
<resource path="{flavor_id}">
|
||||
<param name="flavor_id" style="template" type="csapi:UUID"><doc xml:lang="EN" title="flavor_id">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">
|
||||
UUID for the specific flavor (combination of memory, disk size, and CPUs).
|
||||
|
|
@ -437,10 +437,12 @@
|
|||
path="/csapi:servers" />
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:servers/atom:link[@rel='next']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
<link resource_type="#ServerList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:servers/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#ServerList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
@ -464,9 +466,11 @@
|
|||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:servers/atom:link[@rel='next']/@href">
|
||||
<link resource_type="#DetailServerList" rel="next"/>
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:servers/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#DetailServerList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
@ -715,10 +719,12 @@
|
|||
<representation mediaType="application/xml" element="csapi:addresses">
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:addresses/atom:link[@rel='next']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
<link resource_type="#Addresses" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:addresses/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#Addresses" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
@ -743,10 +749,12 @@
|
|||
<representation mediaType="application/xml" element="csapi:network">
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:network/atom:link[@rel='next']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
<link resource_type="#NetworkAddressList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:network/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#NetworkAddressList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
@ -775,10 +783,12 @@
|
|||
path="/csapi:flavors" ><doc><p xmlns="http://www.w3.org/1999/xhtml">Flavors are known combinations of memory, disk space, and number of CPUs.</p></doc></param>
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:flavors/atom:link[@rel='next']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
<link resource_type="#FlavorList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:flavors/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#FlavorList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
@ -801,10 +811,12 @@
|
|||
<representation mediaType="application/xml" element="csapi:flavors">
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:flavors/atom:link[@rel='next']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
<link resource_type="#DetailFlavorList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:flavors/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#DetailFlavorList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
@ -843,10 +855,12 @@
|
|||
</doc>
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
<link resource_type="#MetadataList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#MetadataList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
@ -894,10 +908,12 @@
|
|||
</doc>
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
<link resource_type="#MetadataList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#MetadataList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
@ -952,10 +968,12 @@
|
|||
</doc>
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the next item in the list.</p></doc>
|
||||
<link resource_type="#MetadataList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">Move to the previous item in the list.</p></doc>
|
||||
<link resource_type="#MetadataList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
|
|
|
|||
|
|
@ -39,17 +39,17 @@
|
|||
<resource id="Images" type="#ImageList" path="images">
|
||||
<method href="#createImage" />
|
||||
<resource path="detail" type="#DetailImageList"/>
|
||||
<resource path="{imageId}">
|
||||
<param name="imageId" style="template" type="xsd:string">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Image ID"><p>Identifier for an image stored via the Image API, typically a uuid.</p></wadl:doc>
|
||||
<resource path="{image_id}">
|
||||
<param name="image_id" style="template" type="xsd:string">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Image ID"><p>Identifier for an image stored via the Image API, typically a UUID.</p></wadl:doc>
|
||||
</param>
|
||||
<method href="#getImage"/>
|
||||
<method href="#updateImage"/>
|
||||
<method href="#deleteImage"/>
|
||||
<resource id="members" path="members" type="#memberList" >
|
||||
<method href="#replaceMember" />
|
||||
<resource path="{tenantId}">
|
||||
<param name="tenantId" style="template" type="xsd:string">
|
||||
<resource path="{tenant_id}">
|
||||
<param name="tenant_id" style="template" type="xsd:string">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Image ID"><p>Identifier for a tenant managed by the Identity service. The Tenant ID can also be labeled as your account number.</p></wadl:doc>
|
||||
</param>
|
||||
<method href="#addMember" />
|
||||
|
|
@ -59,8 +59,8 @@
|
|||
</resource>
|
||||
</resource>
|
||||
<resource id="shared-images" path="shared-images">
|
||||
<resource path="{tenantId}">
|
||||
<param name="tenantId" style="template" type="xsd:string"/>
|
||||
<resource path="{tenant_id}">
|
||||
<param name="tenant_id" style="template" type="xsd:string"/>
|
||||
<method href="#getSharedImages" />
|
||||
</resource>
|
||||
</resource>
|
||||
|
|
|
|||
Loading…
Reference in New Issue