From: Brian Warner <warner@lothar.com>
Date: Tue, 28 Jul 2015 20:15:50 +0000 (-0700)
Subject: webapi.rst: document Range: header on GET requests
X-Git-Tag: allmydata-tahoe-1.10.2b1~6
X-Git-Url: https://git.rkrishnan.org/%5B/%5D%20/uri/frontends/COPYING.GPL?a=commitdiff_plain;h=c3608f61d9131e22f0227d89e785858bf0bdd952;p=tahoe-lafs%2Ftahoe-lafs.git

webapi.rst: document Range: header on GET requests

closes ticket#2460
---

diff --git a/docs/frontends/webapi.rst b/docs/frontends/webapi.rst
index 0968f39b..c3dcea6c 100644
--- a/docs/frontends/webapi.rst
+++ b/docs/frontends/webapi.rst
@@ -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