openstack/api-site
Code Issues Proposed changes

Merge "Add note about 416 return code for overtaxed ranged GET requests"

Browse Source
This commit is contained in:
Jenkins
2016-01-08 16:33:02 +00:00
committed by Gerrit Code Review
parent aaa77d09ff 40c0e291b5
commit ed621808a3
3 changed files with 113 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
api-ref/src/docbkx/ch_objectstorage-v1.xml
View File

@@ -61,6 +61,27 @@ Accept-Ranges: bytes</programlisting>
xlink:href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14">Header xlink:href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14">Header
Field Definitions</link>. Field Definitions</link>.
</para> </para>
<para>
The API returns the <code>Range Not Satisfiable (416)</code> response
code for any ranged &GET; requests that specify more than:
</para>
<itemizedlist>
<listitem>
<para>
Fifty ranges.
</para>
</listitem>
<listitem>
<para>
Three overlapping ranges.
</para>
</listitem>
<listitem>
<para>
Eight non-increasing ranges.
</para>
</listitem>
</itemizedlist>
<section xml:id="storage_info"> <section xml:id="storage_info">
<title>Discoverability</title> <title>Discoverability</title>
<para> <para>

70
api-ref/src/wadls/object-api/src/common.ent
View File

@@ -7,62 +7,72 @@
element="csapi:computeFault"/> element="csapi:computeFault"/>
<representation mediaType="application/json"/> <representation mediaType="application/json"/>
</response>'> </response>'>
<!ENTITY fault503 '<response status="503" xmlns="http://wadl.dev.java.net/2009/02"> <!ENTITY fault503 '
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="csapi:serviceUnavailable"/> element="csapi:serviceUnavailable"/>
<representation mediaType="application/json"/> <representation mediaType="application/json"/>
</response>'> </response>'>
<!ENTITY fault503macGeneration '<response status="503" xmlns="http://wadl.dev.java.net/2009/02"> <!ENTITY fault503macGeneration '
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="csapi:macGenerationFailure"/> element="csapi:macGenerationFailure"/>
<representation mediaType="application/json"/> <representation mediaType="application/json"/>
</response>'> </response>'>
<!ENTITY fault400 '<response status="400" xmlns="http://wadl.dev.java.net/2009/02"> <!ENTITY fault400 '
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="csapi:badRequest"/> element="csapi:badRequest"/>
<representation mediaType="application/json"/> <representation mediaType="application/json"/>
</response>'> </response>'>
<!ENTITY fault401 '<response status="401" xmlns="http://wadl.dev.java.net/2009/02"> <!ENTITY fault401 '
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="csapi:unauthorized"/> element="csapi:unauthorized"/>
<representation mediaType="application/json"/> <representation mediaType="application/json"/>
</response>'> </response>'>
<!ENTITY fault403 '<response status="403" xmlns="http://wadl.dev.java.net/2009/02"> <!ENTITY fault403 '
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="csapi:forbidden"/> element="csapi:forbidden"/>
<representation mediaType="application/json"/> <representation mediaType="application/json"/>
</response>'> </response>'>
<!ENTITY fault404 '<response status="404" xmlns="http://wadl.dev.java.net/2009/02"> <!ENTITY fault404 '
<representation mediaType="application/xml" element="csapi:NotFound"/> <response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/json"/> <representation mediaType="application/xml" element="csapi:NotFound"/>
</response>'> <representation mediaType="application/json"/>
<!ENTITY fault408 '<response status="408" xmlns="http://wadl.dev.java.net/2009/02"> </response>'>
<representation mediaType="application/xml" element="csapi:timeout"/> <!ENTITY fault408 '
<representation mediaType="application/json"/> <response status="408" xmlns="http://wadl.dev.java.net/2009/02">
</response>'> <representation mediaType="application/xml" element="csapi:timeout"/>
<!ENTITY fault409 '<response status="409" xmlns="http://wadl.dev.java.net/2009/02"> <representation mediaType="application/json"/>
<representation mediaType="application/xml" element="csapi:Conflict"/> </response>'>
<representation mediaType="application/json"/> <!ENTITY fault409 '
</response>'> <response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY fault411 '<response status="411" xmlns="http://wadl.dev.java.net/2009/02"> <representation mediaType="application/xml" element="csapi:Conflict"/>
<representation mediaType="application/xml" element="csapi:lengthRequired"/> <representation mediaType="application/json"/>
<representation mediaType="application/json"/> </response>'>
</response>'> <!ENTITY fault411 '
<!ENTITY fault422 '<response status="422" xmlns="http://wadl.dev.java.net/2009/02"> <response status="411" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unprocessableEntity"/> <representation mediaType="application/xml" element="csapi:lengthRequired"/>
<representation mediaType="application/json"/> <representation mediaType="application/json"/>
</response>'> </response>'>
<!ENTITY fault422 '
<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>'>
<!-- Request headers --> <!-- Request headers -->
<!ENTITY accept-requestHeader ' <!ENTITY accept-requestHeader '
<param xmlns="http://wadl.dev.java.net/2009/02" name="Accept" <param xmlns="http://wadl.dev.java.net/2009/02" name="Accept"
style="header" required="false" type="xsd:string"> style="header" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Instead of using the <code>format</code> query <para>
parameter, set this header to Instead of using the <code>format</code> query parameter, set this
<code>application/json</code>, header to <code>application/json</code>,
<code>application/xml</code>, or <code>application/xml</code>, or <code>text/xml</code>.
<code>text/xml</code>.</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY account-meta-name-requestHeader ' <!ENTITY account-meta-name-requestHeader '

56
api-ref/src/wadls/object-api/src/os-object-api-1.0.wadl
View File

@@ -494,6 +494,27 @@ Date: Fri, 17 Jan 2014 16:09:56 GMT</programlisting></para>
If the container does not exist, the call returns the If the container does not exist, the call returns the
<code>Not Found (404)</code> response code. <code>Not Found (404)</code> response code.
</para> </para>
<para>
The operation returns the <code>Range Not Satisfiable (416)</code> response
code for any ranged &GET; requests that specify more than:
</para>
<itemizedlist>
<listitem>
<para>
Fifty ranges.
</para>
</listitem>
<listitem>
<para>
Three overlapping ranges.
</para>
</listitem>
<listitem>
<para>
Eight non-increasing ranges.
</para>
</listitem>
</itemizedlist>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
@@ -541,7 +562,9 @@ Date: Fri, 17 Jan 2014 16:09:56 GMT</programlisting></para>
&container-meta-temp-url-key-requestHeader; &container-meta-temp-url-key-requestHeader;
&container-meta-temp-url-key-2-requestHeader; &container-meta-temp-url-key-2-requestHeader;
</representation> </representation>
</response> &fault404; </method> </response> &fault404;
<response status="416"/>
</method>
<method name="PUT" id="createContainer"> <method name="PUT" id="createContainer">
<!-- create container --> <!-- create container -->
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@@ -889,6 +912,27 @@ Date: Thu, 16 Jan 2014 18:55:00 GMT
&lt;html>&lt;h1>Not Found&lt;/h1>&lt;p>The resource could not be found.&lt;/p>&lt;/html></programlisting></para> &lt;html>&lt;h1>Not Found&lt;/h1>&lt;p>The resource could not be found.&lt;/p>&lt;/html></programlisting></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>
The operation returns the <code>Range Not Satisfiable (416)</code> response
code for any ranged &GET; requests that specify more than:
</para>
<itemizedlist>
<listitem>
<para>
Fifty ranges.
</para>
</listitem>
<listitem>
<para>
Three overlapping ranges.
</para>
</listitem>
<listitem>
<para>
Eight non-increasing ranges.
</para>
</listitem>
</itemizedlist>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
@@ -918,7 +962,9 @@ Date: Thu, 16 Jan 2014 18:55:00 GMT
&static-large-object-responseHeader; &static-large-object-responseHeader;
&trans-id-responseHeader; &Date-ResponseHeader; &trans-id-responseHeader; &Date-ResponseHeader;
</representation> </representation>
</response> &fault404; </method> </response> &fault404;
<response status="416"/>
</method>
<method name="PUT" id="createOrReplaceObject"> <method name="PUT" id="createOrReplaceObject">
<!-- create, replace object --> <!-- create, replace object -->
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@@ -1220,8 +1266,10 @@ Date: Thu, 16 Jan 2014 21:13:19 GMT
</programlisting></para> </programlisting></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>If the request succeeds, the operation returns the <para>
<code>200</code> response code.</para> If the request succeeds, the operation returns the
<code>200</code> response code.
</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">