dirnode.py: fix a bug in the no-write change for Adder, and improve test coverage...

[tahoe-lafs/tahoe-lafs.git] / docs / frontends / webapi.txt

diff --git a/docs/frontends/webapi.txt b/docs/frontends/webapi.txt
index 9678e01041bb3f9b7f59f99fd804edf6ad247b57..9d5afd81d1e279890eb5bb37e71bffbd711e1598 100644 (file)
--- a/docs/frontends/webapi.txt
+++ b/docs/frontends/webapi.txt
@@ -415,9 +415,11 @@ POST /uri?t=mkdir-with-children
  it is acceptable to set "rw_uri" to that cap and omit "ro_uri". The
  client must not put a write cap into a "ro_uri" field.
 
- A file may have a "no-write" metadata field that affects how writes to
- it are handled via the SFTP frontend; see docs/frontends/FTP-and-SFTP.txt
- for details.
+ The metadata may have a "no-write" field. If this is set to true in the
+ metadata of a link, it will not be possible to open that link for writing
+ via the SFTP frontend; see docs/frontends/FTP-and-SFTP.txt for details.
+ Also, if the "no-write" field is set to true in the metadata of a link to
+ a mutable child, it will cause the link to be diminished to read-only.
 
  Note that the webapi-using client application must not provide the
  "Content-Type: multipart/form-data" header that usually accompanies HTML
@@ -669,7 +671,9 @@ GET /uri/$DIRCAP/[SUBDIRS../]FILENAME?t=json
 
   In Tahoe earlier than v1.4.0, only the 'mtime'/'ctime' keys were populated.
   Starting in Tahoe v1.4.0, the 'linkmotime'/'linkcrtime' keys in the 'tahoe'
-  sub-dict are also populated.
+  sub-dict are also populated. However, prior to v1.7.0, a bug caused the
+  'tahoe' sub-dict to be deleted by webapi requests in which new metadata
+  is specified, and not to be added to existing child links that lack it.
 
   The reason we added the new values in Tahoe v1.4.0 is that there is a
   "set_children" API (described below) which you can use to overwrite the