openstack/api-site
Code Issues Proposed changes

Correct flavors API docs for compute api

Browse Source 
There isn't sub-resources 'os-flavor-rxtx' under 'flavors', this patch
removed it. And also use all_extensions api sample instead of only flavor
enabled api sample files, because the nova v2.1 API must enable all
the extensions.

Change-Id: I98da27dd616fe829e9f1d8e9ad6cb58eb5660597
Closes-Bug: #1506281
This commit is contained in:
He Jie Xu 2015-10-15 10:49:44 +08:00 committed by Diane Fleming
parent 3f7aec79ee
commit 044cab859d
4 changed files with 215 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/flavor-get-resp.json Normal file
View File

@ -0,0 +1,24 @@
{
"flavor": {
"OS-FLV-DISABLED:disabled": false,
"OS-FLV-EXT-DATA:ephemeral": 0,
"disk": 1,
"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,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 1
}
}

114
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/flavors-detail-resp.json Normal file
View File

@ -0,0 +1,114 @@
{
"flavors": [
{
"OS-FLV-DISABLED:disabled": false,
"disk": 1,
"OS-FLV-EXT-DATA:ephemeral": 0,
"os-flavor-access:is_public": true,
"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",
"ram": 512,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 1
},
{
"OS-FLV-DISABLED:disabled": false,
"disk": 20,
"OS-FLV-EXT-DATA:ephemeral": 0,
"os-flavor-access:is_public": true,
"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",
"ram": 2048,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 1
},
{
"OS-FLV-DISABLED:disabled": false,
"disk": 40,
"OS-FLV-EXT-DATA:ephemeral": 0,
"os-flavor-access:is_public": true,
"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",
"ram": 4096,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 2
},
{
"OS-FLV-DISABLED:disabled": false,
"disk": 80,
"OS-FLV-EXT-DATA:ephemeral": 0,
"os-flavor-access:is_public": true,
"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",
"ram": 8192,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 4
},
{
"OS-FLV-DISABLED:disabled": false,
"disk": 160,
"OS-FLV-EXT-DATA:ephemeral": 0,
"os-flavor-access:is_public": true,
"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",
"ram": 16384,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 8
}
]
}

74
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/flavors-list-resp.json Normal file
View File

@ -0,0 +1,74 @@
{
"flavors": [
{
"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"
},
{
"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"
},
{
"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"
},
{
"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"
},
{
"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"
}
]
}

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

@ -25,16 +25,6 @@
<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>
@ -53,7 +43,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavor-get-resp.json"
href="../api_samples/all_extensions/flavor-get-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
@ -69,7 +59,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavors-detail-resp.json"
href="../api_samples/all_extensions/flavors-detail-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
@ -85,68 +75,10 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavors-list-resp.json"
href="../api_samples/all_extensions/flavors-list-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</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>