From 59849a9923d7e214725afc14d0d229194884fc54 Mon Sep 17 00:00:00 2001 From: "Zack M. Davis" Date: Thu, 22 Oct 2015 15:13:09 -0700 Subject: [PATCH] SLO docs(tring): manifest params in table, code block; copyedits MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It's æsthetically pleasing to display the segment description parameters in a table (using the reStructuredText "simple" table markup) and to use a code block (which receives syntax hightlighting in the rendered document!) for the example JSON fragment. Also, a few very minor copy changes are made (a comma after an introductory phrase clarifies; JSON and ETag receieve their canonical capitalizations; the elements of the manifest JSON aren't "files" exactly; the inclusive nature of the range is noted for the benefit of harried readers who won't read the "Range Specification" section later in the document). Change-Id: I5296fc04c6fe5410ad14bba7de0a7f8ab060b126 --- swift/common/middleware/slo.py | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/swift/common/middleware/slo.py b/swift/common/middleware/slo.py index f3561c29e2..f46f6b7d54 100644 --- a/swift/common/middleware/slo.py +++ b/swift/common/middleware/slo.py @@ -26,26 +26,31 @@ defined manifest of the object segments is used. Uploading the Manifest ---------------------- -After the user has uploaded the objects to be concatenated a manifest is +After the user has uploaded the objects to be concatenated, a manifest is uploaded. The request must be a PUT with the query parameter:: ?multipart-manifest=put -The body of this request will be an ordered list of files in -json data format. The data to be supplied for each segment is:: +The body of this request will be an ordered list of segment descriptions in +JSON format. The data to be supplied for each segment is: - path: the path to the segment object (not including account) - /container/object_name - etag: the etag given back when the segment object was PUT, - or null - size_bytes: the size of the complete segment object in - bytes, or null - range: (Optional) the range within the object to use as a - segment. If omitted, the entire object is used. +=========== ======================================================== +Key Description +=========== ======================================================== +path the path to the segment object (not including account) + /container/object_name +etag the ETag given back when the segment object was PUT, + or null +size_bytes the size of the complete segment object in + bytes, or null +range (optional) the (inclusive) range within the object to + use as a segment. If omitted, the entire object is used. +=========== ======================================================== -The format of the list will be:: +The format of the list will be: + + .. code:: - json: [{"path": "/cont/object", "etag": "etagoftheobjectsegment", "size_bytes": 10485760,