From: david-sarah Date: Sat, 11 Sep 2010 00:31:47 +0000 (-0700) Subject: docs/frontends/webapi.txt: document that the meaning of the 'healthy' field may chang... X-Git-Tag: allmydata-tahoe-1.8.0c4~5 X-Git-Url: https://git.rkrishnan.org/tahoe_css?a=commitdiff_plain;h=31f66c5470641890d0606fe8b7b8a68fb21dfa5c;p=tahoe-lafs%2Ftahoe-lafs.git docs/frontends/webapi.txt: document that the meaning of the 'healthy' field may change in future to reflect servers-of-happiness; refs #614 --- diff --git a/docs/frontends/webapi.txt b/docs/frontends/webapi.txt index 52c3c555..bf23dafc 100644 --- a/docs/frontends/webapi.txt +++ b/docs/frontends/webapi.txt @@ -1199,13 +1199,15 @@ POST $URL?t=check query. healthy: (bool) True if the file is completely healthy, False otherwise. Healthy files have at least N good shares. Overlapping shares - (indicated by count-good-share-hosts < count-shares-good) do not - currently cause a file to be marked unhealthy. If there are at - least N good shares, then corrupt shares do not cause the file to - be marked unhealthy, although the corrupt shares will be listed - in the results (list-corrupt-shares) and should be manually + do not currently cause a file to be marked unhealthy. If there + are at least N good shares, then corrupt shares do not cause the + file to be marked unhealthy, although the corrupt shares will be + listed in the results (list-corrupt-shares) and should be manually removed to wasting time in subsequent downloads (as the downloader rediscovers the corruption and uses alternate shares). + Future compatibility: the meaning of this field may change to + reflect whether the servers-of-happiness criterion is met + (see ticket #614). sharemap: dict mapping share identifier to list of serverids (base32-encoded strings). This indicates which servers are holding which shares. For immutable files, the shareid is