openstack/api-site
Code Issues Proposed changes

Merge "Compute v2.1 docs clean up (part2)"

Browse Source
This commit is contained in:
Jenkins 2015-09-04 14:25:19 +00:00 committed by Gerrit Code Review
commit 67b32340c0
3 changed files with 70 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -249,9 +249,9 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-flavors-v2.1">
<title>Flavors with extended attributes (flavors)</title>
<title>Flavors with extended attributes (flavors, os-flavor-rxtx)</title>
<para>
Shows information about flavors.
Shows information about flavors with extended attributes.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-flavors-v2.1.wadl"
@ -298,17 +298,6 @@
href="../wadls/compute-api/src/v2.1/wadl/os-flavor-manage-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-flavor-rxtx-v2.1">
<title>Flavors with rxtx_factor extended attribute
(flavors, os-flavor-rxtx)
</title>
<para>
Shows the rxtx status of a flavor.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-flavor-rxtx-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="keypairs-v2.1">
<title>Keypairs (keypairs)</title>
<para>Generates, imports, and deletes SSH keys.</para>

92
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-flavor-rxtx-v2.1.wadl
View File

@ -1,92 +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-flavor-rxtx-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="flavors" path="flavors">
<resource id="os-flavor-rxtx" path="os-flavor-rxtx">
<method href="#createflavor"/>
<resource id="details" path="detail">
<method href="#returnallflavor"/>
</resource>
<resource id="flavor_id" path="{flavor_id}">
&flavorIdRequestParameter;
<method href="#returndata"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!-- *******************************************************-->
<!-- OS Flavor rxtx -->
<!--*******************************************************-->
<method name="GET" id="returndata">
<wadl:doc xml:lang="EN" title="Show flavor details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified
flavor.</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-flavor-rxtx/flavor-rxtx-get-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="returnallflavor">
<wadl:doc xml:lang="EN" title="List flavors with details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists flavors with details.</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-flavor-rxtx/flavor-rxtx-list-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="POST" id="createflavor">
<wadl:doc xml:lang="EN" title="Create flavor"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a flavor.</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-flavor-rxtx/flavor-rxtx-post-req.json"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-post-resp.json"
/>
</wadl:doc>
</representation>
</response>
</method>
</application>

68
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-flavors-v2.1.wadl
View File

@ -25,6 +25,16 @@
<resource id="detail" path="detail">
<method href="#returnflavorall"/>
</resource>
<resource id="os-flavor-rxtx" path="os-flavor-rxtx">
<method href="#createflavor"/>
<resource id="details" path="detail">
<method href="#returnallflavor"/>
</resource>
<resource id="flavor_id2" path="{flavor_id}">
&flavorIdRequestParameter;
<method href="#returndata"/>
</resource>
</resource>
</resource>
</resource>
</resource>
@ -81,4 +91,62 @@
</request>
<response status="200"> &x-openstack-request-idHeader;</response>
</method>
<!-- *******************************************************-->
<!-- OS Flavor rxtx -->
<!--*******************************************************-->
<method name="GET" id="returndata">
<wadl:doc xml:lang="EN" title="Show flavor details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified
flavor.</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-flavor-rxtx/flavor-rxtx-get-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="returnallflavor">
<wadl:doc xml:lang="EN" title="List flavors with details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists flavors with details.</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-flavor-rxtx/flavor-rxtx-list-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="POST" id="createflavor">
<wadl:doc xml:lang="EN" title="Create flavor"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a flavor.</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-flavor-rxtx/flavor-rxtx-post-req.json"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-post-resp.json"
/>
</wadl:doc>
</representation>
</response>
</method>
</application>