openstack
/
api-site
Code Issues Proposed changes

Add the X-Detect-Content-Type request header 

Also, fixed issues with a nested entity
&name; inside another entity (build failed)

Closes-Bug: #1274988

Change-Id: I06d0efeb88287182f0f04574f68039e6294fc40a
author: diane fleming
This commit is contained in:
Diane Fleming 2014-03-15 18:03:03 -05:00
parent 3b63fb4ed4
commit f4d2b0d095
3 changed files with 36 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/pom.xml
View File

@ -33,7 +33,8 @@
<phase>generate-sources</phase>
<configuration>
<includes> api-ref.xml, api-ref-identity.xml,
api-ref-compute-v2.xml, api-ref-compute-v2-ext.xml, api-ref-compute-v3-ext.xml, api-ref-image.xml,
api-ref-compute-v2.xml, api-ref-compute-v2-ext.xml,
api-ref-compute-v3-ext.xml, api-ref-image.xml,
api-ref-networking.xml, api-ref-objectstorage.xml,
api-ref-blockstorage.xml, api-ref-orchestration.xml,
api-ref-telemetry.xml </includes>

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

@ -63,7 +63,7 @@
</wadl:doc>
</param>'>
<!ENTITY account-meta-name-requestHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-&name;" style="header" required="false"
name="X-Account-Meta-name" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
@ -114,7 +114,7 @@
</wadl:doc>
</param>'>
<!ENTITY container-meta-name-requestHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Meta-&name;" style="header" required="false"
name="X-Container-Meta-name" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
@ -246,6 +246,16 @@ object is removed.</para></wadl:doc>
destination container and object before you include them
in this header.</para></wadl:doc>
</param>'>
<!ENTITY detect-content-type-requestHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Detect-Content-Type" style="header" required="false"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
><para>If set to <code>true</code>, Object Storage guesses
the content type based on the file extension and ignores
the value sent in the <code>Content-Type</code> header, if
present.</para></wadl:doc>
</param>'>
<!ENTITY ETag-requestHeader '<param xmlns="http://wadl.dev.java.net/2009/02" name="ETag"
style="header" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -322,7 +332,7 @@ include them in this header.</para>
</wadl:doc>
</param>'>
<!ENTITY object-meta-name-requestHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Object-Meta-&name;" style="header" required="false"
name="X-Object-Meta-name" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
@ -393,7 +403,7 @@ include them in this header.</para>
</itemizedlist></wadl:doc>
</param>'>
<!ENTITY remove-account-meta-name-requestHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Remove-Account-Meta-&name;" style="header" required="false"
name="X-Remove-Account-Meta-name" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
@ -415,7 +425,7 @@ include them in this header.</para>
want to remove.</para></wadl:doc>
</param>'>
<!ENTITY remove-container-meta-name-requestHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Remove-Container-Meta-&name;" style="header" required="false"
name="X-Remove-Container-Meta-name" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
@ -426,7 +436,7 @@ include them in this header.</para>
item to remove.</para></wadl:doc>
</param>'>
<!ENTITY remove-container-name-requestHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Remove-Container-&name;" style="header"
name="X-Remove-Container-name" style="header"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
@ -616,7 +626,7 @@ include them in this header.</para>
</wadl:doc>
</param>'>
<!ENTITY account-meta-name-responseHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Account-Meta-&name;" style="header" required="false"
name="X-Account-Meta-name" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
@ -711,7 +721,7 @@ total.</para></wadl:doc>
</wadl:doc>
</param>'>
<!ENTITY container-meta-name-responseHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Meta-&name;" style="header" required="true"
name="X-Container-Meta-name" style="header" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
@ -904,7 +914,7 @@ The value is the container and object name prefix of the segment objects
in the form <code>container/prefix</code>.</para></wadl:doc>
</param>'>
<!ENTITY object-meta-name-responseHeader '<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Object-Meta-&name;" style="header" required="true"
name="X-Object-Meta-name" style="header" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"

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

@ -252,7 +252,9 @@ Date: Fri, 17 Jan 2014 16:08:15 GMT</programlisting></para></listitem>
<request> &auth-token-requestHeader-required;
&account-meta-temp-url-key-requestHeader;
&account-meta-temp-url-key-2-requestHeader;
&account-meta-name-requestHeader; </request>
&account-meta-name-requestHeader;
&content-type-requestHeader;
&detect-content-type-requestHeader; </request>
<response status="204"> &content-length-responseHeader-OP;
&content-type-responseHeader-OP; &trans-id-responseHeader;
&date-responseHeader; </response>
@ -456,7 +458,9 @@ Date: Tue, 14 Jan 2014 19:25:43 GMT</programlisting></para></listitem>
&container-sync-to-requestHeader;
&container-sync-key-requestHeader;
&versions-location-requestHeader;
&container-meta-name-requestHeader; </request>
&container-meta-name-requestHeader;
&content-type-requestHeader;
&detect-content-type-requestHeader; </request>
<response status="201 204"> &content-length-responseHeader-OP;
&content-type-responseHeader-OP; &trans-id-responseHeader;
&date-responseHeader; </response>
@ -543,7 +547,9 @@ Date: Thu, 16 Jan 2014 18:37:04 GMT</programlisting></para>
&container-sync-key-requestHeader;
&versions-location-requestHeader;
&remove-versions-location-requestHeader;
&container-meta-name-requestHeader; </request>
&container-meta-name-requestHeader;
&content-type-requestHeader;
&detect-content-type-requestHeader; </request>
<response status="204"> &content-length-responseHeader-OP;
&content-type-responseHeader-OP; &trans-id-responseHeader;
&date-responseHeader; </response>
@ -789,8 +795,10 @@ Date: Fri, 17 Jan 2014 17:28:35 GMT</programlisting></para></listitem>
&auth-token-requestHeader-optional;
&content-length-requestHeader-putObj;
&transfer-encoding-requestHeader;
&content-type-requestHeader; &copy-from-requestHeader;
&ETag-requestHeader; &content-disposition-requestHeader;
&content-type-requestHeader;
&detect-content-type-requestHeader;
&copy-from-requestHeader; &ETag-requestHeader;
&content-disposition-requestHeader;
&content-encoding-requestHeader; &delete-at-requestHeader;
&delete-after-requestHeader;
&object-meta-name-requestHeader; </request>
@ -1057,7 +1065,8 @@ Date: Thu, 16 Jan 2014 21:18:28 GMT
&object-meta-name-requestHeader; &delete-at-requestHeader;
&content-disposition-requestHeader;
&content-encoding-requestHeader;
&delete-after-requestHeader; &content-type-requestHeader; </request>
&delete-after-requestHeader; &content-type-requestHeader;
&detect-content-type-requestHeader; </request>
<response status="202"> &content-length-responseHeader-OP;
&content-type-responseHeader; &trans-id-responseHeader;
&date-responseHeader; </response>