From 6e402a3c91e781af689c88f855b1700fb4e03c8a Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 26 Dec 2013 18:50:55 +0100 Subject: [PATCH] Remove extra whitespace Cleanup extraneous whitespace like end of line whitespace or whitespace before . Change-Id: I83a26dae9f6f7e9af522c2418d64c2efae9d61f1 --- .../ch_object-api-general.xml | 8 +- .../ch_object-api-overview.xml | 6 +- ...ch_object-api-troubleshooting-examples.xml | 86 +++++++++---------- .../section_object-api-create-website.xml | 22 ++--- ...ction_object-api-storage-container-svc.xml | 36 ++++---- .../section_object-api-storage-object-svc.xml | 6 +- ...section_object-api-storage_account_svc.xml | 12 +-- 7 files changed, 88 insertions(+), 88 deletions(-) diff --git a/openstack-object-storage-dev/ch_object-api-general.xml b/openstack-object-storage-dev/ch_object-api-general.xml index efc3727..1ef5120 100644 --- a/openstack-object-storage-dev/ch_object-api-general.xml +++ b/openstack-object-storage-dev/ch_object-api-general.xml @@ -44,11 +44,11 @@ format="SVG" scale="60"/> token HTTP x-header, defined as X-Auth-Token. Clients obtain this token, along with the Cloud Servers API URL, by first using an authentication service and - supplying a valid username and API access key. + supplying a valid username and API access key. Request To authenticate, you must supply your username and - API access key in x-headers: + API access key in x-headers: @@ -71,13 +71,13 @@ format="SVG" scale="60"/> Keystone), or you can use your own authentication system. Place your access key in the X-Auth-Key - x-header. + x-header. - Authentication HTTP Request + Authentication HTTP Request diff --git a/openstack-object-storage-dev/ch_object-api-overview.xml b/openstack-object-storage-dev/ch_object-api-overview.xml index aeff346..caa2cd7 100644 --- a/openstack-object-storage-dev/ch_object-api-overview.xml +++ b/openstack-object-storage-dev/ch_object-api-overview.xml @@ -37,7 +37,7 @@ format="SVG" scale="60"/> data. You can store an unlimited quantity of files and each file can be as large as 5 GBs, plus with large object creation, you can upload and store objects of virtually any - size. + size. OpenStack Object Storage allows users to store and retrieve files and content through a simple Web Service interface (ReST: Representational State Transfer). There are also @@ -51,7 +51,7 @@ format="SVG" scale="60"/> We welcome feedback, comments, and bug reports at http://bugs.launchpad.net/swift. + >http://bugs.launchpad.net/swift.
Intended Audience This guide is intended to assist software developers who @@ -63,7 +63,7 @@ format="SVG" scale="60"/> here, you should first have a general understanding of the OpenStack Object Storage service and have access to an installation of OpenStack Object Storage. You should also - be familiar with: + be familiar with: ReSTful web services diff --git a/openstack-object-storage-dev/ch_object-api-troubleshooting-examples.xml b/openstack-object-storage-dev/ch_object-api-troubleshooting-examples.xml index dc92c2c..81998c9 100644 --- a/openstack-object-storage-dev/ch_object-api-troubleshooting-examples.xml +++ b/openstack-object-storage-dev/ch_object-api-troubleshooting-examples.xml @@ -41,11 +41,11 @@ format="SVG" scale="60"/> UNIX®-like environments and Mac OS X® and can be downloaded for Windows®. For more information on cURL, visit http://curl.haxx.se/. + >http://curl.haxx.se/. cURL allows you to transmit and receive HTTP requests and responses from the command-line or from within a shell script. This makes it possible to work with the ReST API - directly without using one of the client APIs. + directly without using one of the client APIs. The following cURL command-line options will be used @@ -139,7 +139,7 @@ Content-Type: text/plain
Listing and Creating Containers - The simplest operation for Object Storage is to simply + The simplest operation for Object Storage is to simply list the containers you have, which when you don't have any containers yet isn't terribly exciting: @@ -150,7 +150,7 @@ Content-Type: text/plain https://storage.swiftdrive.com/v1/CF_xer7_343 - + HTTP/1.1 204 No Content X-Account-Object-Count: 0 X-Account-Bytes-Used: 0 @@ -178,7 +178,7 @@ Date: Mon, 07 Nov 2011 17:07:01 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/george - + HTTP/1.1 201 Created Content-Length: 18 Content-Type: text/html; charset=UTF-8 @@ -201,7 +201,7 @@ Date: Mon, 07 Nov 2011 17:44:20 GMT https://storage.swiftdrive.com/v1/CF_xer7_343 - + HTTP/1.1 200 OK X-Account-Object-Count: 0 X-Account-Bytes-Used: 0 @@ -236,7 +236,7 @@ george https://storage.swiftdrive.com/v1/CF_xer7_343 - + HTTP/1.1 200 OK X-Account-Object-Count: 0 X-Account-Bytes-Used: 0 @@ -266,7 +266,7 @@ jerry https://storage.swiftdrive.com/v1/CF_xer7_343?limit=2 - + HTTP/1.1 200 OK X-Account-Object-Count: 0 X-Account-Bytes-Used: 0 @@ -294,7 +294,7 @@ dogs https://storage.swiftdrive.com/v1/CF_xer7_343?marker=dogs\&limit=2 - + HTTP/1.1 200 OK X-Account-Object-Count: 0 X-Account-Bytes-Used: 0 @@ -332,7 +332,7 @@ george https://storage.swiftdrive.com/v1/CF_xer7_343?format=json - + HTTP/1.1 200 OK X-Account-Object-Count: 0 X-Account-Bytes-Used: 0 @@ -359,7 +359,7 @@ Date: Mon, 07 Nov 2011 19:17:33 GMT https://storage.swiftdrive.com/v1/CF_xer7_343?format=xml - + HTTP/1.1 200 OK X-Account-Object-Count: 0 X-Account-Bytes-Used: 0 @@ -402,11 +402,11 @@ Date: Mon, 07 Nov 2011 19:17:38 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/dogs - + HTTP/1.1 204 No Content X-Container-Object-Count: 0 X-Container-Bytes-Used: 0 -Accept-Ranges: bytes +Accept-Ranges: bytes X-Trans-Id: tx3dd984f9482341dd97546e9d49d65e90 Content-Length: 0 Date: Mon, 07 Nov 2011 20:39:41 GMT @@ -424,7 +424,7 @@ Date: Mon, 07 Nov 2011 20:39:41 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/george - + HTTP/1.1 204 No Content Content-Length: 0 Content-Type: text/html; charset=UTF-8 @@ -443,7 +443,7 @@ Date: Mon, 07 Nov 2011 20:42:58 GMT https://storage.swiftdrive.com/v1/CF_xer7_343 - + HTTP/1.1 200 OK X-Account-Object-Count: 0 X-Account-Bytes-Used: 0 @@ -480,7 +480,7 @@ jerry https://storage.swiftdrive.com/v1/CF_xer7_343/jerry - + HTTP/1.1 204 No Content X-Container-Object-Count: 0 X-Container-Bytes-Used: 0 @@ -505,7 +505,7 @@ Date: Tue, 15 Nov 2011 03:29:22 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/jerry - + HTTP/1.1 202 Accepted Content-Length: 58 Content-Type: text/html; charset=UTF-8 @@ -527,7 +527,7 @@ The request is accepted for processing. https://storage.swiftdrive.com/v1/CF_xer7_343/jerry - + HTTP/1.1 204 No Content X-Container-Object-Count: 0 X-Container-Read: .r:*,.rlistings @@ -557,7 +557,7 @@ Date: Tue, 15 Nov 2011 03:33:36 GMT Sample File Listing - + $ ls -l total 504 -rw-r--r--@ 1 petecj2 staff 44765 Nov 7 14:49 JingleRocky.jpg @@ -616,7 +616,7 @@ Date: Mon, 07 Nov 2011 22:51:30 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/dogs - + HTTP/1.1 200 OK X-Container-Object-Count: 1 X-Container-Read: .r:*,.rlistings @@ -644,7 +644,7 @@ JingleRocky.jpg https://storage.swiftdrive.com/v1/CF_xer7_343/dogs - + HTTP/1.1 200 OK X-Container-Object-Count: 3 X-Container-Read: .r:*,.rlistings @@ -791,7 +791,7 @@ Etag: "0c922c37f915efb1c9b97e6328b3e660" https://storage.swiftdrive.com/v1/CF_xer7_343/dogs?limit=2 - + HTTP/1.1 200 OK X-Container-Object-Count: 3 X-Container-Read: .r:*,.rlistings @@ -816,7 +816,7 @@ RockyAndBuster.jpg https://storage.swiftdrive.com/v1/CF_xer7_343/dogs?marker=RockyAndBuster.jpg\&limit=2 - + HTTP/1.1 200 OK X-Container-Object-Count: 3 X-Container-Read: .r:*,.rlistings @@ -839,12 +839,12 @@ SittingBuster.jpg Removing Local Copies - + $ ls -l total 504 -rw-r--r--@ 1 petecj2 staff 44765 Nov 7 14:49 JingleRocky.jpg -rw-r--r--@ 1 petecj2 staff 100864 Nov 7 14:47 RockyAndBuster.jpg --rw-r--r--@ 1 petecj2 staff 107103 Nov 7 14:47 SittingBuster.jpg +-rw-r--r--@ 1 petecj2 staff 107103 Nov 7 14:47 SittingBuster.jpg $ rm JingleRocky.jpg $ ls -l total 416 @@ -863,7 +863,7 @@ total 416 https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg > JingleRocky.jpg - + $ ls -l total 504 -rw-r--r-- 1 petecj2 staff 44765 Nov 7 15:11 JingleRocky.jpg @@ -887,7 +887,7 @@ total 504 https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/JingleRocky.jpg - + HTTP/1.1 201 Created Content-Length: 118 Content-Type: text/html; charset=UTF-8 @@ -924,7 +924,7 @@ Date: Mon, 07 Nov 2011 23:23:54 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/ - + HTTP/1.1 200 OK X-Container-Object-Count: 1 X-Container-Bytes-Used: 44765 @@ -948,7 +948,7 @@ JingleRocky.jpg https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/JingleRocky.jpg - + HTTP/1.1 204 No Content Content-Length: 0 Content-Type: text/html; charset=UTF-8 @@ -967,7 +967,7 @@ Date: Mon, 07 Nov 2011 23:32:39 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/ - + HTTP/1.1 204 No Content X-Container-Object-Count: 0 X-Container-Bytes-Used: 0 @@ -994,7 +994,7 @@ Date: Mon, 07 Nov 2011 23:32:41 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg - + <html> <head> <title>202 Accepted</title> @@ -1020,7 +1020,7 @@ Date: Mon, 07 Nov 2011 23:32:41 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg - + HTTP/1.1 200 OK X-Object-Meta-Breed: Terrier pit bull mix Last-Modified: Tue, 08 Nov 2011 01:26:49 GMT @@ -1054,7 +1054,7 @@ Date: Mon, 07 Nov 2011 23:32:41 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/photos - + HTTP/1.1 201 Created Content-Length: 18 Content-Type: text/html; charset=UTF-8 @@ -1074,7 +1074,7 @@ Date: Wed, 16 Nov 2011 00:06:22 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/photos - + HTTP/1.1 204 No Content X-Container-Object-Count: 0 X-Container-Bytes-Used: 0 @@ -1096,7 +1096,7 @@ Date: Wed, 16 Nov 2011 00:06:26 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/photos/terriers/JingleRocky.jpg - + HTTP/1.1 201 Created Content-Length: 118 Content-Type: text/html; charset=UTF-8 @@ -1112,9 +1112,9 @@ Date: Wed, 16 Nov 2011 00:09:19 GMT <body> <h1>201 Created</h1> <br /><br /> - - - + + + </body> </html> @@ -1131,7 +1131,7 @@ Date: Wed, 16 Nov 2011 00:09:19 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/photos/chihuahuas/SittingBuster.jpg - + HTTP/1.1 201 Created Content-Length: 118 Content-Type: text/html; charset=UTF-8 @@ -1164,7 +1164,7 @@ Date: Wed, 16 Nov 2011 00:52:25 GMT https://storage.swiftdrive.com/v1/CF_xer7_343/photos - + HTTP/1.1 200 OK X-Container-Object-Count: 2 X-Container-Bytes-Used: 151868 @@ -1174,7 +1174,7 @@ Content-Type: text/plain; charset=utf-8 X-Trans-Id: tx8544a17e8b1e4da693145fb5f2e6db43 Date: Wed, 16 Nov 2011 00:53:43 GMT -chihuahuas/SittingBuster.jpg +chihuahuas/SittingBuster.jpg terriers/JingleRocky.jpg @@ -1190,7 +1190,7 @@ terriers/JingleRocky.jpg https://storage.swiftdrive.com/v1/CF_xer7_343/photos?path=terriers - + HTTP/1.1 200 OK X-Container-Object-Count: 2 X-Container-Bytes-Used: 151868 @@ -1215,7 +1215,7 @@ terriers/JingleRocky.jpg https://storage.swiftdrive.com/v1/CF_xer7_343/photos?delimiter=/ - + HTTP/1.1 200 OK X-Container-Object-Count: 2 X-Container-Bytes-Used: 151868 diff --git a/openstack-object-storage-dev/section_object-api-create-website.xml b/openstack-object-storage-dev/section_object-api-create-website.xml index cfbf826..c992927 100644 --- a/openstack-object-storage-dev/section_object-api-create-website.xml +++ b/openstack-object-storage-dev/section_object-api-create-website.xml @@ -57,41 +57,41 @@ format="SVG" scale="60"/> pseudo-directories in your container, the index page displays by default for each sub-directory. If your pseudo-directory does not have a file with the same name as your index file, - visits to the sub-directory return a 404 error. + visits to the sub-directory return a 404 error. You also have the option of displaying a list of files in your pseudo-directory instead of a web page. You do this by setting the X-Container-Meta-Web-Listings header to TRUE. You may add style to your file listing by setting X-Container-Meta-Web-Listings-CSS: to - a style sheet (for example, lists.css). + a style sheet (for example, lists.css).
Static Web Middleware through swift Make Container Publicly Readable - Make the container publicly readable. Once the + Make the container publicly readable. Once the container is publicly readable, you may access your objects directly, but you will need to set the index file to browse the main site URL and its - sub-directories. + sub-directories. swift post -r '.r:*' container Set Site Index File Set the index file. In this case, index.html is the default file - displayed when the site displays. + displayed when the site displays. swift post -m 'web-index:index.html' container Enable File Listing Turn on file listing. If you do not set the index file, list the objects in the container. Instructions - on styling the list with the CSS follow. + on styling the list with the CSS follow. swift post -m 'web-listings: true' container Enable CSS for File Listing - Style the file listing. + Style the file listing.
@@ -100,8 +100,8 @@ format="SVG" scale="60"/> You can create and set custom error pages for visitors to your website; currently, only 401 (Unauthorized) and 404 (Not Found) errors are supported. To do this, set the - metadata header, X-Container-Meta-Web-Error. - Error pages are served with the <status> code + metadata header, X-Container-Meta-Web-Error. + Error pages are served with the <status> code prepended to the name of the error page you set. For instance, if you set X-Container-Meta-Web-Error to @@ -110,9 +110,9 @@ format="SVG" scale="60"/> will display 404error.html. You must have both of these pages created in your container when you set the X-Container-Meta-Web-Error metadata, or - your site will display generic error pages. + your site will display generic error pages. Set the X-Container-Meta-Web-Error metadata - once for your entire static website. + once for your entire static website. Set Error Pages for Static Website Request diff --git a/openstack-object-storage-dev/section_object-api-storage-container-svc.xml b/openstack-object-storage-dev/section_object-api-storage-container-svc.xml index 2c88d26..03d6aae 100644 --- a/openstack-object-storage-dev/section_object-api-storage-container-svc.xml +++ b/openstack-object-storage-dev/section_object-api-storage-container-svc.xml @@ -207,7 +207,7 @@ format="SVG" scale="60"/> - Get Objects Details HTTP and JSON Response + Get Objects Details HTTP and JSON Response @@ -216,7 +216,7 @@ format="SVG" scale="60"/> - Objects Details Request: XML + Objects Details Request: XML @@ -263,7 +263,7 @@ reddelicious list. By using end_marker we can limit the result set to object names less than the given - value. + value.
@@ -294,11 +294,11 @@ reddelicious Request To display a list of all the objects in the storage container, use &GET; without a - delimiter or prefix. + delimiter or prefix. GET /v1/AccountString/backups The system returns status code 2xx (between 200 and 299, inclusive) and the requested list of the - objects. + objects. photos/animals/cats/persian.jpg photos/animals/cats/siamese.jpg photos/animals/dogs/corgi.jpg @@ -313,7 +313,7 @@ photos/plants/rose.jpg results. Any character may be used as a delimiter. However, to use delimiter with pseudo-directories, use the parameter slash - (/). + (/). GET /v1/AccountString/backups?delimiter=/ The system returns status code 2xx (between 200 and 299, inclusive) and the requested matching @@ -324,17 +324,17 @@ photos/plants/rose.jpg They have a content-type of application/directory and are in the subdir section of json and xml - results. + results. photos/ Use the prefix parameter with the delimiter parameter to view the objects inside a pseudo-directory, including - further nested pseudo-directories. + further nested pseudo-directories. GET /v1/AccountString/backups?prefix=photos/&delimiter=/ The system returns status code 2xx (between 200 and 299, inclusive) and the objects and pseudo-directories within the top level - pseudo-directory. + pseudo-directory. photos/animals/ photos/me.jpg photos/plants/ @@ -346,7 +346,7 @@ photos/plants/ called dogs within the pseudo-directory animals. In order to navigate directly to the files contained within - dogs, enter the below command. + dogs, enter the below command. GET /v1/AccountString/backups?prefix=photos/animals/dogs/&delimiter=/ The system returns status code 2xx (between 200 and 299, inclusive) and the objects and @@ -368,9 +368,9 @@ photos/animals/dogs/terrier.jpg Containers can be assigned custom metadata by including additional HTTP headers on the &PUT; request. The custom metadata is assigned to a container via HTTP headers - identified with the X-Container-Meta- prefix. + identified with the X-Container-Meta- prefix. - Create Container HTTP Request + Create Container HTTP Request No content is returned. A status code of 201 (Created) @@ -417,7 +417,7 @@ photos/animals/dogs/terrier.jpg Delete Container &DELETE; operations against a storage container permanently remove it. The container must be empty before - it can be deleted. + it can be deleted. A &HEAD; request against the container can be used to determine if it contains any objects. @@ -463,10 +463,10 @@ photos/animals/dogs/terrier.jpg Create or Update Container Metadata You may create any custom or arbitrary metadata headers as you find useful. They must, however, take the format - X-Container-Meta-. + X-Container-Meta-. To create or update the arbitrary container metadata, use the &POST; query. Subsequent requests of the same - key/value pair overwrites the previous value. + key/value pair overwrites the previous value. Update Container Metadata HTTP Request @@ -474,7 +474,7 @@ photos/animals/dogs/terrier.jpg No response body is returned. A status code of 2xx (between 200 and 299, inclusive) indicates success; status 404 (Not Found) is returned when the requested container does not - exist. + exist. Update Container Metadata HTTP Response @@ -498,7 +498,7 @@ photos/animals/dogs/terrier.jpg Delete Container Metadata To delete a metadata header send an empty value for that particular header, such as - X-Container-Meta-Book:. + X-Container-Meta-Book:. If the tool you're using to communicate with Object Storage doesn't support sending empty headers (older versions of curl) send the header @@ -512,7 +512,7 @@ photos/animals/dogs/terrier.jpg Delete Container Metadata HTTP Request No response body is returned. A status code of 2xx - (between 200 and 299, inclusive) indicates success. + (between 200 and 299, inclusive) indicates success. diff --git a/openstack-object-storage-dev/section_object-api-storage-object-svc.xml b/openstack-object-storage-dev/section_object-api-storage-object-svc.xml index 7c70766..d5c5a45 100644 --- a/openstack-object-storage-dev/section_object-api-storage-object-svc.xml +++ b/openstack-object-storage-dev/section_object-api-storage-object-svc.xml @@ -458,7 +458,7 @@ header in a &PUT; operation. This creates a new manifest object that shares the same set of segment objects as the original manifest - object. + object. @@ -845,10 +845,10 @@ remove an object and you have five total versions of it, you must &DELETE; it five times. - A large-object manifest file cannot be versioned, + A large-object manifest file cannot be versioned, but it may point to versioned segments. - To turn off Object Versioning on your current version + To turn off Object Versioning on your current version container, remove its X-Versions-Location metadata by sending an empty key value. 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 38ec304..2a93f73 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 @@ -163,7 +163,7 @@ format="SVG" scale="60"/> format=json argument is appended to the storage account URL, the service serves extended container information serialized in the chosen format. - The sample responses are formatted for readability. + The sample responses are formatted for readability. The following HTTP request asks for a JSON response, so the response returns an HTTP header and a JSON response. @@ -238,7 +238,7 @@ oranges list. By using end_marker we can limit the result set to container names less than the - given value. + given value. apples bananas @@ -276,16 +276,16 @@ kiwis Create or Update Account Metadata You can associate custom metadata headers with the account level URI. These headers must take the format - X-Account-Meta-*. + X-Account-Meta-*. To create or update an account metadata header use the &POST; query. Subsequent requests for the same key/value - pair overwrite the previous value. + pair overwrite the previous value. Update Account Metadata HTTP Request No response body is returned. A status code of 2xx - (between 200 and 299, inclusive) indicates success. + (between 200 and 299, inclusive) indicates success. Update Account Metadata HTTP Response @@ -306,7 +306,7 @@ kiwis Delete Account Metadata To delete a metadata header, send an empty value for that particular header, such as for the - X-Account-Meta-Book header. + 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