document store: Document as-needed functionality of AddFull

Mention the new flag and its functionality in the portal API
documentation.
tingping/wmclass
Matthias Clasen 2017-05-29 09:43:35 -04:00
parent 4a54450400
commit 5d610b9ddd
1 changed files with 6 additions and 1 deletions

View File

@ -99,7 +99,7 @@
<!--
AddFull:
@o_path_fds: open file descriptors for the files to export
@flags: flags, 1 == reuse_existing, 2 == persistent
@flags: flags, 1 == reuse_existing, 2 == persistent, 3 == as-needed-by-app
@app_id: an application ID, or empty string
@permissions: the permissions to grant, possible values are 'read', 'write', 'grant-permissions' and 'delete'
@doc_ids: the IDs of the files in the document store
@ -109,6 +109,11 @@
form of an open file descriptor to prove that the caller has
access to the file.
If the as-needed-by-app flag is given, files will only be added to
the document store if the application does not already have access to them.
For files that are not added to the document store, the doc_ids array will
contain an empty string.
Additionally, if app_id is specified, it will be given the permissions
listed in GrantPermission.