From a0431b85701fb99e87f8892424b3360d2c5f12a6 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Wed, 16 Oct 2013 15:23:40 -0500 Subject: [PATCH] Editorial changes - object-api dev guide backport: havana Change-Id: Ic9a831568002b6ab02d7506693c0ff36852795f6 author: diane fleming --- .../bk_os-objectstorage-devguide.xml | 29 ++++++++++---- .../ch_object-api-storage-services.xml | 15 +++---- openstack-object-storage-dev/pom.xml | 5 +-- ...section_object-api-storage_account_svc.xml | 40 ++++++++++--------- 4 files changed, 51 insertions(+), 38 deletions(-) diff --git a/openstack-object-storage-dev/bk_os-objectstorage-devguide.xml b/openstack-object-storage-dev/bk_os-objectstorage-devguide.xml index 57dae0d..8923980 100644 --- a/openstack-object-storage-dev/bk_os-objectstorage-devguide.xml +++ b/openstack-object-storage-dev/bk_os-objectstorage-devguide.xml @@ -66,12 +66,24 @@ Application Programming Interface (API) v1. + + 2013-10-16 + + + + Updated the description of the delete account + metadata method. + + + + 2013-09-28 - Clarify UTF-8 and URL-encoding of container and object names in headers. + Clarify UTF-8 and URL-encoding of container and + object names in headers. @@ -81,7 +93,8 @@ - Corrected delete container to be delete object. + Corrected delete container to be delete + object. @@ -160,9 +173,8 @@ Revised for OpenStack Object Storage use by removing CDN references, Rackspace Cloud references, and revised account examples and URLs for generic - implementations. It's not a changed requirement that - Container and Object names are required to be UTF-8, - but it's pointed out in the documentation. + implementations. Clarified that container and object + names must be UTF-8 encoded. @@ -174,7 +186,8 @@ Removed references to ACL (Access Control List). Fixed error in examples referring to X-Auth-Key where - it should be X-Auth-Token. Added section numbers. + it should be X-Auth-Token. Added section + numbers. @@ -192,7 +205,7 @@ - 2008-05-5 + 2008-05-05 @@ -207,5 +220,5 @@ - + diff --git a/openstack-object-storage-dev/ch_object-api-storage-services.xml b/openstack-object-storage-dev/ch_object-api-storage-services.xml index 2fe6a97..07e83a8 100644 --- a/openstack-object-storage-dev/ch_object-api-storage-services.xml +++ b/openstack-object-storage-dev/ch_object-api-storage-services.xml @@ -49,29 +49,30 @@ format="SVG" scale="60"/> character restrictions. - Object and container names must be UTF-8 encoded and then URL-encoded to interact with - the ReST API. + Object and container names must be UTF-8 encoded and then + URL-encoded to interact with the ReST API. The following sections describe the actions that you can perform in - the storage system. + the storage system. . Actions that - you can perform at the account level of the storage system. + you can perform at the account level of the storage system. + . Actions that - you can perform on containers. + you can perform on containers. . How to - use your swift account to create a static website. + use your swift account to create a static website. . Actions that - you can perform on objects. + you can perform on objects. diff --git a/openstack-object-storage-dev/pom.xml b/openstack-object-storage-dev/pom.xml index 923cb09..bef8e66 100644 --- a/openstack-object-storage-dev/pom.xml +++ b/openstack-object-storage-dev/pom.xml @@ -1,9 +1,7 @@ - + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> 4.0.0 - org.openstack.docs openstack-object-api-guide 1.0.0 @@ -53,7 +51,6 @@ - 1 1 0 diff --git a/openstack-object-storage-dev/section_object-api-storage_account_svc.xml b/openstack-object-storage-dev/section_object-api-storage_account_svc.xml index d1cfa57..00d946b 100644 --- a/openstack-object-storage-dev/section_object-api-storage_account_svc.xml +++ b/openstack-object-storage-dev/section_object-api-storage_account_svc.xml @@ -133,8 +133,8 @@ format="SVG" scale="60"/> A list of containers is returned in the response body, - one container per line. The HTTP response's status code will - be 2xx (between 200 and 299, inclusive). + one container per line. The HTTP response's status code + will be 2xx (between 200 and 299, inclusive). List Containers HTTP Response @@ -246,8 +246,9 @@ kiwis The HTTP return code will be 2xx (between 200 and 299, - inclusive) if the request succeeds. A 401 (Unauthorized) will - be returned for an invalid account or access key. + inclusive) if the request succeeds. A 401 (Unauthorized) + will be returned for an invalid account or access + key. Get Account Metadata HTTP Response @@ -255,17 +256,17 @@ kiwis
Create or Update Account Metadata - You can associate custom metadata headers with the + You can associate custom metadata headers with the account level URI. These headers must take the format X-Account-Meta-*. - To create or update an account metadata header use the + To create or update an account metadata header use the &POST; query. Subsequent requests for the same key/value pair overwrite the previous value. Update Account Metadata HTTP Request - No response body is returned. A status code of 2xx + No response body is returned. A status code of 2xx (between 200 and 299, inclusive) indicates success. Update Account Metadata HTTP Response @@ -285,21 +286,22 @@ kiwis
Delete Account Metadata - To delete a metadata header send an empty value for that - particular header, such as - X-Account-Meta-Book. - If the tool you're using to communicate with Swift - doesn't support sending empty headers (such as older - versions of cURL) send the header - "X-Remove-Account-Meta-name: - arbitrary value", such as - X-Remove-Account-Meta-Book: x. The - value is ignored. + To delete a metadata header, send an empty value for + that particular header, such as for the + X-Account-Meta-Book header. + If the tool you use to communicate with Object Storage, + such as older versions of cURL, does not support empty + headers, send the + X-Remove-Account-Meta-name: + arbitrary value header. For + example, X-Remove-Account-Meta-Book: x. The + arbitrary value is + ignored. Delete Account Metadata HTTP Request - No response body is returned. A status code of 2xx - (between 200 and 299, inclusive) indicates success. + No response body is returned. A status code from 200 + to 299 indicates success.