openstack/api-site
Code Issues Proposed changes

Merge "Compute v2.1 docs clean up"

Browse Source
This commit is contained in:
Jenkins
2015-09-04 14:17:40 +00:00
committed by Gerrit Code Review
parent 3c019508ab 46436afdf3
commit 0dfefdf68c
15 changed files with 0 additions and 906 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
api-ref/src/docbkx/ch_compute-v2.1.xml
View File

@@ -107,15 +107,6 @@
href="../wadls/compute-api/src/v2.1/wadl/os-admin-password-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-create-backup-v2.1">
<title>Servers backups (servers, action)</title>
<para>
Creates backup for a server instance.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-create-backup-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-console-output-v2.1">
<title>Servers console output (servers, action)</title>
<para>
@@ -238,41 +229,6 @@
href="../wadls/compute-api/src/v2.1/wadl/os-config-drive-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-extended-availability-zone-v2.1">
<title>Servers with extended availability zones
(servers, os-extended-availability-zones)
</title>
<para>
Shows the instance availability zone for compute nodes (nova-
compute). Internal services appear in their own internal availability
zone.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-extended-availability-zone-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-extended-server-attributes-v2.1">
<title>Servers extended attributes
(servers, os-extended-server-attributes)
</title>
<para>
Shows metadata for servers.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-extended-server-attributes-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-extended-status-v2.1">
<title>Servers extended status (servers, os-extended-status)</title>
<para>
Shows extended status information, <code>vm_state</code>,
<code>task_state</code>, and <code>power_state</code>, in detailed
server responses.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-extended-status-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-server-password-v2.1">
<title>Servers password (servers, os-server-password)</title>
<para>
@@ -292,15 +248,6 @@
href="../wadls/compute-api/src/v2.1/wadl/os-virtual-interfaces-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-extended-volumes-v2.1">
<title>Servers extended volumes (servers)</title>
<para>
Lists servers with attached volume information.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-extended-volumes-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-flavors-v2.1">
<title>Flavors with extended attributes (flavors)</title>
<para>

58
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-extended-server-attributes/server-get-resp.json
View File

@@ -1,58 +0,0 @@
{
"server": {
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-16T02:55:07Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "3bf189131c61d0e71b0a8686a897a0f50d1693b48c47b721fe77155b",
"id": "c278163e-36f9-4cf2-b1ac-80db4c63f7a8",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/c278163e-36f9-4cf2-b1ac-80db4c63f7a8",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/c278163e-36f9-4cf2-b1ac-80db4c63f7a8",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"OS-EXT-SRV-ATTR:host": "c5f474bf81474f9dbbc404d5b2e4e9b3",
"OS-EXT-SRV-ATTR:hypervisor_hostname": "fake-mini",
"OS-EXT-SRV-ATTR:instance_name": "instance-00000001",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-16T02:55:08Z",
"user_id": "fake"
}
}

16
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-extended-server-attributes/server-post-resp.json
View File

@@ -1,16 +0,0 @@
{
"server": {
"adminPass": "UCvmH8nHXm66",
"id": "a8c1c13d-ec7e-47c7-b4ff-077f72c1ca46",
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/a8c1c13d-ec7e-47c7-b4ff-077f72c1ca46",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/a8c1c13d-ec7e-47c7-b4ff-077f72c1ca46",
"rel": "bookmark"
}
]
}
}

60
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-extended-server-attributes/servers-detail-resp.json
View File

@@ -1,60 +0,0 @@
{
"servers": [
{
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-16T02:55:03Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "63cf07a9fd82e1d2294926ec5c0d2e1e0ca449224246df75e16f23dc",
"id": "a8c1c13d-ec7e-47c7-b4ff-077f72c1ca46",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/a8c1c13d-ec7e-47c7-b4ff-077f72c1ca46",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/a8c1c13d-ec7e-47c7-b4ff-077f72c1ca46",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"OS-EXT-SRV-ATTR:host": "bc8efe4fdb7148a4bb921a2b03d17de6",
"OS-EXT-SRV-ATTR:hypervisor_hostname": "fake-mini",
"OS-EXT-SRV-ATTR:instance_name": "instance-00000001",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-16T02:55:05Z",
"user_id": "fake"
}
]
}

58
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-extended-status/server-get-resp.json
View File

@@ -1,58 +0,0 @@
{
"server": {
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-16T03:07:06Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "46d2aa2d637bd55606304b611a1928627ee1278c149aef2206268d6e",
"id": "a868cb5e-c794-47bf-9cd8-e302b72bb94b",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/a868cb5e-c794-47bf-9cd8-e302b72bb94b",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/a868cb5e-c794-47bf-9cd8-e302b72bb94b",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"OS-EXT-STS:power_state": 1,
"OS-EXT-STS:task_state": null,
"OS-EXT-STS:vm_state": "active",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-16T03:07:07Z",
"user_id": "fake"
}
}

60
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-extended-status/servers-detail-resp.json
View File

@@ -1,60 +0,0 @@
{
"servers": [
{
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-16T03:07:09Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "a275e77473e464558c4aba0d68e1914d1164e7ee2f69affde7aaae2b",
"id": "6c8b5385-e74c-4fd5-add6-2fcf42d74a98",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/6c8b5385-e74c-4fd5-add6-2fcf42d74a98",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/6c8b5385-e74c-4fd5-add6-2fcf42d74a98",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"OS-EXT-STS:power_state": 1,
"OS-EXT-STS:task_state": null,
"OS-EXT-STS:vm_state": "active",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-16T03:07:10Z",
"user_id": "fake"
}
]
}

63
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-extended-volumes/server-get-resp.json
View File

@@ -1,63 +0,0 @@
{
"server": {
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-16T03:22:28Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "8feef92e2152b9970b51dbdade024afbec7f8f03daf7cb335a3c1cb9",
"id": "7d62983e-23df-4320-bc89-bbc77f2a2e40",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/7d62983e-23df-4320-bc89-bbc77f2a2e40",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/7d62983e-23df-4320-bc89-bbc77f2a2e40",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"os-extended-volumes:volumes_attached": [
{
"id": "volume_id1"
},
{
"id": "volume_id2"
}
],
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-16T03:22:29Z",
"user_id": "fake"
}
}

65
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-extended-volumes/servers-detail-resp.json
View File

@@ -1,65 +0,0 @@
{
"servers": [
{
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-16T03:22:32Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "f9622ec1b5ab6e3785661ea1c1e0294f95aecbcf27ac4cb60b06bd02",
"id": "8e479732-7701-48cd-af7a-04d84f51b742",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/8e479732-7701-48cd-af7a-04d84f51b742",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/8e479732-7701-48cd-af7a-04d84f51b742",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"os-extended-volumes:volumes_attached": [
{
"id": "volume_id1"
},
{
"id": "volume_id2"
}
],
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-16T03:22:34Z",
"user_id": "fake"
}
]
}

92
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-create-backup-v2.1.wadl
View File

@@ -1,92 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<!-- (C) 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"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
<resources base="https://servers.api.openstack.com"
xml:id="os-create-backup-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#backupserver"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!-- *******************************************************-->
<!-- Admin Actions -->
<!--*******************************************************-->
<method name="POST" id="backupserver">
<wadl:doc xml:lang="EN" title="Back up server"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Backs up a server instance.</para>
<para>
Specify the <code>createBackup</code> action in the request
body.
</para>
<para>
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
<code>policy.json</code> file.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-create-backup/create-backup-req.json"
/>
</wadl:doc>
<param
name="name" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
The name for the backup.
</para>
</wadl:doc>
</param>
<param
name="backup_type" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
The backup type. A valid value is
<code>daily</code> or <code>weekly</code>.
</para>
</wadl:doc>
</param>
<param
name="rotation" style="plain"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
The number of backups to maintain. A valid value
is greater than or equal to zero.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
</method>
</application>

68
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-extended-availability-zone-v2.1.wadl
View File

@@ -1,68 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
<resources base="https://servers.api.openstack.com"
xml:id="os-extended-availability-zone-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource id="os-extended-availability-zones" path="os-extended-availability-zones">
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<method href="#returndetails"/>
</resource>
<resource id="detail" path="detail">
<method href="#returnlist"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- OS extended availability zone -->
<!--*******************************************************-->
<method name="GET" id="returndetails">
<wadl:doc xml:lang="EN" title="Show server details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified
server.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-availability-zone/server-get-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="returnlist">
<wadl:doc xml:lang="EN" title="List server details for user"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists server details for a
specified user.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-availability-zone/servers-detail-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
</application>

68
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-extended-server-attributes-v2.1.wadl
View File

@@ -1,68 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
<resources base="https://servers.api.openstack.com"
xml:id="os-extended-server-attributes-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource id="os-extended-server-attributes" path="os-extended-server-attributes">
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<method href="#returnserverdetails"/>
</resource>
<resource id="details" path="details">
<method href="#returnlistdetails"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!-- *******************************************************-->
<!-- OS extended server attributes -->
<!--*******************************************************-->
<method name="GET" id="returnserverdetails">
<wadl:doc xml:lang="EN" title="Shows server details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified
server.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-server-attributes/server-get-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="returnlistdetails">
<wadl:doc xml:lang="EN" title="Lists server details for user"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists server details for a
specified user.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-server-attributes/servers-detail-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
</application>

65
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-extended-status-v2.1.wadl
View File

@@ -1,65 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
<resources base="https://servers.api.openstack.com" xml:id="os-extended-status-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource id="os-extended-status" path="os-extended-status">
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<method href="#returnserverdetails"/>
</resource>
<resource id="detail" path="detail">
<method href="#returnlistserver"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!-- *******************************************************-->
<!-- OS extended status -->
<!--*******************************************************-->
<method name="GET" id="returnserverdetails">
<wadl:doc xml:lang="EN" title="Show server details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified server.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-status/server-get-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="returnlistserver">
<wadl:doc xml:lang="EN" title="List servers with details for user"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists servers with details for a specified user.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-status/servers-detail-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
</application>

66
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-extended-volumes-v2.1.wadl
View File

@@ -1,66 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
<resources base="https://servers.api.openstack.com"
xml:id="os-extended-volumes-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource path="detail" id="detail">
<method href="#list-volumes"/>
</resource>
<resource path="{server_id}" id="server_id">
&serverIdRequestParameter;
<method href="#show-volume"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="show-volume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show volume details">
<para role="shortdesc">Shows volume information for a specified
server.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-extended-volumes/servers-detail-resp.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="list-volumes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List volumes">
<para role="shortdesc">
Lists servers with attached volume information.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-extended-volumes/server-get-resp.json"
/>
</wadl:doc>
</representation>
</response>
</method>
</application>

56
api-ref/src/wadls/compute-api/src/v2/api_samples/os-extended-availability-zone/server-get-resp.json
View File

@@ -1,56 +0,0 @@
{
"server": {
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"mac_addr": "aa:bb:cc:dd:ee:ff",
"type": "fixed",
"version": 4
}
]
},
"created": "2013-09-16T02:54:56Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"host_id": "b75d6736650f9b272223ceb48f4cde001de1856e381613a922117ab7",
"id": "f22e4521-d03a-4e9f-9fd3-016b9e227219",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/f22e4521-d03a-4e9f-9fd3-016b9e227219",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/f22e4521-d03a-4e9f-9fd3-016b9e227219",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"os-extended-availability-zone:availability_zone": "nova",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-16T02:54:57Z",
"user_id": "fake"
}
}

58
api-ref/src/wadls/compute-api/src/v2/api_samples/os-extended-availability-zone/servers-detail-resp.json
View File

@@ -1,58 +0,0 @@
{
"servers": [
{
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"mac_addr": "aa:bb:cc:dd:ee:ff",
"type": "fixed",
"version": 4
}
]
},
"created": "2013-09-16T02:54:56Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"host_id": "cf5540800371e53064a60b36ff9d6d1d6a8719ffc870c63a270c6bee",
"id": "55f43fa2-dc7c-4c0b-b21a-76f9abe516f9",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/55f43fa2-dc7c-4c0b-b21a-76f9abe516f9",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/55f43fa2-dc7c-4c0b-b21a-76f9abe516f9",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"os-extended-availability-zone:availability_zone": "nova",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-16T02:54:58Z",
"user_id": "fake"
}
]
}