openstack/api-site
Code Issues Proposed changes

Add error response codes to Orchestration API

Browse Source 
Change-Id: I4a03d37074050d861225c3fcae2a9e6b2a413023
This commit is contained in:
Jason Dunsmore 2015-08-05 15:05:15 -05:00
parent 3f69b2c92a
commit ecdaf5a0c9
2 changed files with 76 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref/src/wadls/orchestration-api/src/v1/common.ent
View File

@ -280,3 +280,27 @@
</para>
</wadl:doc>
</param> '>
<!ENTITY commonFaults '
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" title="Bad Request"
xml:lang="EN" />
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" title="Unauthorized"
xml:lang="EN" />
</response> '>
<!ENTITY notFound '
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" title="Not Found"
xml:lang="EN" />
</response> '>
<!ENTITY conflict '
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" title="Conflict"
xml:lang="EN" />
</response> '>
<!ENTITY intServerErr '
<response status="500" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" title="Internal Server Error"
xml:lang="EN" />
</response> '>

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

@ -462,6 +462,8 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&intServerErr;
</method>
<method name="POST" id="stack_create">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -599,6 +601,9 @@
</param>
</representation>
</response>
&commonFaults;
&conflict;
&intServerErr;
</method>
<method name="POST" id="stack_preview">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -768,6 +773,9 @@
</param>
</representation>
</response>
&commonFaults;
&conflict;
&intServerErr;
</method>
<method name="POST" id="stack_adopt">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -854,6 +862,9 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&conflict;
&intServerErr;
</method>
<method name="POST" id="stack_action_suspend">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -987,6 +998,9 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="GET" id="stack_show">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1004,6 +1018,9 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="GET" id="stack_template">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1021,6 +1038,9 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="PUT" id="stack_update">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@ -1095,6 +1115,9 @@
</representation>
</request>
<response status="202"/>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="DELETE" id="stack_delete">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@ -1104,6 +1127,9 @@
</para>
</wadl:doc>
<response status="204"/>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="DELETE" id="stack_abandon">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1122,6 +1148,9 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="POST" id="stack_snapshot">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1285,6 +1314,9 @@
Lists all available template versions.
</para>
</wadl:doc>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="GET" id="resource_type_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1301,6 +1333,7 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="GET" id="resource_type_get">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@ -1322,6 +1355,7 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="GET" id="resource_type_template">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@ -1347,6 +1381,8 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
</method>
<method name="GET" id="stack_resources_find">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1416,6 +1452,8 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
</method>
<method name="GET" id="resource_show">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@ -1432,6 +1470,8 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
</method>
<method name="GET" id="resource_metadata">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1556,6 +1596,9 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="GET" id="resource_event_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1635,6 +1678,8 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
</method>
<method name="GET" id="event_show">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1755,6 +1800,8 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
</method>
<method name="GET" id="software_config_show">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1772,6 +1819,8 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
</method>
<method name="DELETE" id="software_config_delete">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1799,6 +1848,9 @@
</wadl:doc>
</representation>
</response>
&commonFaults;
&notFound;
&intServerErr;
</method>
<method name="GET" id="software_deployment_metadata">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"