openstack/api-site
Code Issues Proposed changes

Merge "improve examples in heat api-ref"

Browse Source
This commit is contained in:
Jenkins
2014-06-06 13:07:42 +00:00
committed by Gerrit Code Review
parent c50412535e a2a4f492fa
commit b3597d7020
6 changed files with 137 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl
View File

@@ -272,7 +272,14 @@
</wadl:doc>
</param>
</request>
<response status="200"/>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="samples/stack_list_resp.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="stack_create">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@@ -342,7 +349,14 @@
</wadl:doc>
</representation>
</request>
<response status="201"/>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="samples/stack_create_resp.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="stack_preview">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@@ -514,7 +528,14 @@
</wadl:doc>
</representation>
</request>
<response status="201"/>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="samples/stack_adopt_resp.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="stack_action_suspend">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@@ -574,7 +595,15 @@
to &GET; when you receive a 302 because this behavior
is ubiquitous in web browsers.</para>
</wadl:doc>
<response status="302"/>
<response status="302">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/stack_find_resp.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="stack_show">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@@ -582,7 +611,15 @@
<para role="shortdesc">Shows details for a specified
stack.</para>
</wadl:doc>
<response status="200"/>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/stack_show_resp.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="stack_template">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"

11
api-ref/src/wadls/orchestration-api/src/v1/samples/stack_adopt_resp.json Normal file
View File

@@ -0,0 +1,11 @@
{
"stack": {
"id": "5333af0c-cc26-47ee-ac3d-8784cefafbd7",
"links": [
{
"href": "http://192.168.123.200:8004/v1/eb1c63a4f77141548385f113a28f0f52/stacks/simple_stack/5333af0c-cc26-47ee-ac3d-8784cefafbd7",
"rel": "self"
}
]
}
}

11
api-ref/src/wadls/orchestration-api/src/v1/samples/stack_create_resp.json Normal file
View File

@@ -0,0 +1,11 @@
{
"stack": {
"id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"links": [
{
"href": "http://192.168.123.200:8004/v1/eb1c63a4f77141548385f113a28f0f52/stacks/simple_stack/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"rel": "self"
}
]
}
}

27
api-ref/src/wadls/orchestration-api/src/v1/samples/stack_find_resp.json Normal file
View File

@@ -0,0 +1,27 @@
{
"stack": {
"capabilities": [],
"creation_time": "2014-06-04T20:36:12Z",
"description": "sample stack",
"disable_rollback": true,
"id": "5333af0c-cc26-47ee-ac3d-8784cefafbd7",
"links": [
{
"href": "http://192.168.123.200:8004/v1/eb1c63a4f77141548385f113a28f0f52/stacks/simple_stack/5333af0c-cc26-47ee-ac3d-8784cefafbd7",
"rel": "self"
}
],
"notification_topics": [],
"outputs": [],
"parameters": {
"OS::stack_id": "5333af0c-cc26-47ee-ac3d-8784cefafbd7",
"OS::stack_name": "simple_stack"
},
"stack_name": "simple_stack",
"stack_status": "CREATE_COMPLETE",
"stack_status_reason": "Stack CREATE completed successfully",
"template_description": "sample stack",
"timeout_mins": null,
"updated_time": null
}
}

19
api-ref/src/wadls/orchestration-api/src/v1/samples/stack_list_resp.json Normal file
View File

@@ -0,0 +1,19 @@
{
"stacks": [
{
"creation_time": "2014-06-03T20:59:46Z",
"description": "sample stack",
"id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"links": [
{
"href": "http://192.168.123.200:8004/v1/eb1c63a4f77141548385f113a28f0f52/stacks/simple_stack/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"rel": "self"
}
],
"stack_name": "simple_stack",
"stack_status": "CREATE_COMPLETE",
"stack_status_reason": "Stack CREATE completed successfully",
"updated_time": ""
}
]
}

27
api-ref/src/wadls/orchestration-api/src/v1/samples/stack_show_resp.json Normal file
View File

@@ -0,0 +1,27 @@
{
"stack": {
"capabilities": [],
"creation_time": "2014-06-03T20:59:46Z",
"description": "sample stack",
"disable_rollback": "True",
"id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"links": [
{
"href": "http://192.168.123.200:8004/v1/eb1c63a4f77141548385f113a28f0f52/stacks/simple_stack/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"rel": "self"
}
],
"notification_topics": [],
"outputs": [],
"parameters": {
"OS::stack_id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"OS::stack_name": "simple_stack"
},
"stack_name": "simple_stack",
"stack_status": "CREATE_COMPLETE",
"stack_status_reason": "Stack CREATE completed successfully",
"template_description": "sample stack",
"timeout_mins": "",
"updated_time": ""
}
}