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
This commit is contained in:
Timur Alperovich 2017-02-22 12:03:20 -08:00
parent fc09dda92b
commit 5f11163b79

View File

@ -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::