From 5f11163b79a085d42c430952d3bbbeb88cad705e Mon Sep 17 00:00:00 2001 From: Timur Alperovich Date: Wed, 22 Feb 2017 12:03:20 -0800 Subject: [PATCH] Expand SLO manifest documentation. The patch adds documentation for the SLO raw format, specifically what the fields are in relation to the documented format (hash vs etag, bytes vs size_bytes, and name vs path). Change-Id: I44c74ad406a6e55e4228f52fac623eeabbd7564f --- swift/common/middleware/slo.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/swift/common/middleware/slo.py b/swift/common/middleware/slo.py index 90b416afb7..5d58b29240 100644 --- a/swift/common/middleware/slo.py +++ b/swift/common/middleware/slo.py @@ -191,7 +191,19 @@ A GET request with the query parameter:: ?multipart-manifest=get will return a transformed version of the original manifest, containing -additional fields and different key names. +additional fields and different key names. For example, the first manifest in +the example above would look like this: + + .. code:: + + [{"name": "/cont/object", + "hash": "etagoftheobjectsegment", + "bytes": 10485760, + "range": "1048576-2097151"}, ...] + +As you can see, some of the fields are renamed compared to the put request: +*path* is *name*, *etag* is *hash*, *size_bytes* is *bytes*. The *range* field +remains the same (if present). A GET request with the query parameters::