webapi.rst: document Range: header on GET requests
authorBrian Warner <warner@lothar.com>
Tue, 28 Jul 2015 20:15:50 +0000 (13:15 -0700)
committerBrian Warner <warner@lothar.com>
Tue, 28 Jul 2015 20:15:50 +0000 (13:15 -0700)
closes ticket#2460

docs/frontends/webapi.rst

index 0968f39baa891f37005dca0ee35d8a4c79de48c7..c3dcea6c7e12f0e73662dd03c72cfcd4a29bf874 100644 (file)
@@ -348,7 +348,10 @@ Reading a File
 ``GET /uri/$DIRCAP/[SUBDIRS../]FILENAME``
 
  This will retrieve the contents of the given file. The HTTP response body
- will contain the sequence of bytes that make up the file.
+ will contain the sequence of bytes that make up the file. The "Range:"
+ header can be used to restrict which portions of the file are returned (see
+ RFC 2616 section 14.35.1 "Byte Ranges"), however Tahoe only supports a
+ single "bytes" range and never provides a `multipart/byteranges` response.
 
  To view files in a web browser, you may want more control over the
  Content-Type and Content-Disposition headers. Please see the next section