Update Object API v1 to spellcheck and make other changes
- Remove passive voice from api-site - Renamed api-ref/src/wadls/object-api/src/v1/api_samples to .../samples - Renamed code samples using this naming convention: <resource>-<action>-request.json or <resource>-<action>-response.json. For example, volume-create-request.json and volume-create-response.json. - Removed unused code samples - Made method names consistent throughout - use list<resource> for list operations, show<resource> for show operations, and so on. Change-Id: Id2dbc9f35014954bf5b297bd4ebed4d37d0d14f1 Partial-Bug: #1521244
This commit is contained in:
Diane Fleming
parent
21efc0404c
commit
2999c98292
@ -83,7 +83,7 @@
|
||||
<method href="#showContainerDetails"/>
|
||||
</resource_type>
|
||||
<resource_type id="ObjectDetails">
|
||||
<method href="#getObject"/>
|
||||
<method href="#showObject"/>
|
||||
</resource_type>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Methods -->
|
||||
@ -109,7 +109,7 @@
|
||||
xml:lang="EN">
|
||||
<xsdxt:sample>
|
||||
<xsdxt:code
|
||||
href="samples/info_response.json"
|
||||
href="samples/capabilities-list-response.json"
|
||||
/>
|
||||
</xsdxt:sample>
|
||||
</wadl:doc>
|
||||
@ -141,10 +141,10 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:sample>
|
||||
<xsdxt:code href="samples/endpoint_list_response.json"/>
|
||||
<xsdxt:code href="samples/endpoints-list-response.json"/>
|
||||
</xsdxt:sample>
|
||||
<xsdxt:sample>
|
||||
<xsdxt:code href="samples/endpoint_list_response_headers.json"/>
|
||||
<xsdxt:code href="samples/endpoints-list-response-headers.json"/>
|
||||
</xsdxt:sample>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
@ -239,9 +239,9 @@
|
||||
xml:lang="EN"
|
||||
title="List containers response: HTTP and JSON">
|
||||
<xsdxt:code
|
||||
href="samples/account_containers_list_http_response_json.txt"
|
||||
href="samples/account-containers-list-http-response-json.txt"
|
||||
/><xsdxt:code
|
||||
href="samples/account_containers_list_response.json"
|
||||
href="samples/account-containers-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
@ -250,9 +250,9 @@
|
||||
xml:lang="EN"
|
||||
title="List containers response: HTTP and XML">
|
||||
<xsdxt:code
|
||||
href="samples/account_containers_list_http_response_xml.txt"/>
|
||||
href="samples/account-containers-list-http-response-xml.txt"/>
|
||||
<xsdxt:code
|
||||
href="samples/account_containers_list_response.xml"
|
||||
href="samples/account-containers-list-response.xml"
|
||||
/>
|
||||
</wadl:doc> &content-length-responseHeader-NAMES;
|
||||
&content-type-responseHeader-NAMES;
|
||||
@ -285,12 +285,14 @@
|
||||
the existing value.
|
||||
</para>
|
||||
<para>
|
||||
To delete a metadata header, send an empty value for that header, such as for the
|
||||
<code>X-Account-Meta-Book</code> header. If the tool you use to communicate with
|
||||
Object Storage, such as an older version of cURL, does not support empty headers,
|
||||
send the <code>X-Remove-Account-Meta-{name}</code> header with an arbitrary value.
|
||||
For example, <code>X-Remove-Account-Meta-Book: x</code>. The operation ignores the
|
||||
arbitrary value.
|
||||
To delete a metadata header, send an empty value for that
|
||||
header, such as for the <code>X-Account-Meta-Book</code>
|
||||
header. If the tool you use to communicate with Object
|
||||
Storage, such as an older version of cURL, does not support
|
||||
empty headers, send the <code>X-Remove-Account-Meta-{name}</code>
|
||||
header with an arbitrary value. For
|
||||
example, <code>X-Remove-Account-Meta-Book: x</code>. The
|
||||
operation ignores the arbitrary value.
|
||||
</para>
|
||||
<para>
|
||||
If the container already has other custom metadata items, a
|
||||
@ -492,9 +494,9 @@ Date: Fri, 17 Jan 2014 16:09:56 GMT</programlisting>
|
||||
xml:lang="EN"
|
||||
title="Show container details response: HTTP and JSON">
|
||||
<xsdxt:code
|
||||
href="samples/object_list_http_response_json.txt"/>
|
||||
href="samples/objects-list-http-response-json.txt"/>
|
||||
<xsdxt:code
|
||||
href="samples/object_list_response.json"/>
|
||||
href="samples/objects-list-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
@ -502,9 +504,9 @@ Date: Fri, 17 Jan 2014 16:09:56 GMT</programlisting>
|
||||
xml:lang="EN"
|
||||
title="Show container details response: HTTP and XML">
|
||||
<xsdxt:code
|
||||
href="samples/object_list_http_response_xml.txt"/>
|
||||
href="samples/objects-list-http-response-xml.txt"/>
|
||||
<xsdxt:code
|
||||
href="samples/object_list_response.xml"/>
|
||||
href="samples/objects-list-response.xml"/>
|
||||
</wadl:doc> &content-length-responseHeader-NAMES;
|
||||
&container-object-count-responseHeader;
|
||||
&accept-ranges-responseHeader;
|
||||
@ -785,7 +787,7 @@ Date: Thu, 16 Jan 2014 18:05:31 GMT
|
||||
<!--*******************************************************-->
|
||||
<!-- Object-level operations -->
|
||||
<!--*******************************************************-->
|
||||
<method name="GET" id="getObject">
|
||||
<method name="GET" id="showObject">
|
||||
<!-- Get object content and metadata -->
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get object content and metadata">
|
||||
|
||||
@ -9,4 +9,4 @@
|
||||
"bytes": 14,
|
||||
"name": "marktwain"
|
||||
}
|
||||
]
|
||||
]
|
||||
@ -13,4 +13,4 @@
|
||||
"name": "helloworld",
|
||||
"content_type": "application/octet-stream"
|
||||
}
|
||||
]
|
||||
]
|
||||
Loading…
x
Reference in New Issue
Block a user