Skip to content

Commit 7d98260

Browse files
Update doc/release-notes/11299-file-restrict-api-extension.md
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
1 parent a05a56f commit 7d98260

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
### Extend Restrict API to include new attributes
22

3-
Original /restrict API only allowed for a boolean to update the restricted attribute of a file
3+
Original /restrict API only allowed for a boolean to update the restricted attribute of a file.
44
The extended API still allows for the single boolean for backward compatibility.
5-
This change also allows for a Json object to be passed which allows for the required ``restrict`` flag as well as optional attributes: ``enableAccessRequest`` and ``termsOfAccess``.
6-
If ``enableAccessRequest`` is false then the ``termsOfAccess`` text must also be included.
5+
This change also allows for a JSON object to be passed which allows for the required `restrict` flag as well as optional attributes: `enableAccessRequest` and `termsOfAccess`.
6+
If `enableAccessRequest` is false then the `termsOfAccess` text must also be included.
7+
8+
See [the guides](https://dataverse-guide--11349.org.readthedocs.build/en/11349/api/native-api.html#restrict-files), #11299, and #11349.

0 commit comments

Comments
 (0)