Skip to content

dirindex doc should show use of DOI for end users #7800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kcondon merged 4 commits into from
Apr 23, 2021
Merged

dirindex doc should show use of DOI for end users #7800

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2e5784
dirindex doc should show use of DOI for end users
mankoff Apr 14, 2021
469b96b
Update doc/sphinx-guides/source/api/native-api.rst
mankoff Apr 14, 2021
c0071a5
Update doc/sphinx-guides/source/api/native-api.rst
mankoff Apr 14, 2021
1914e76
Use variables rather than hard-coded dataset
mankoff Apr 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions doc/sphinx-guides/source/api/native-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,10 @@ View Dataset Files and Folders as a Directory Index

.. code-block:: bash

curl $SERVER_URL/api/datasets/$ID/dirindex/
curl $SERVER_URL/api/datasets/${ID}/dirindex/
# or
curl ${SERVER_URL}/api/datasets/:persistentId/dirindex?persistentId=doi:${PERSISTENT_ID}


Optional parameters:

Expand Down Expand Up @@ -867,7 +870,9 @@ An example of a ``wget`` command line for crawling ("recursive downloading") of

.. code-block:: bash

wget -r -e robots=off -nH --cut-dirs=3 --content-disposition https://demo.dataverse.org/api/datasets/24/dirindex/
wget -r -e robots=off -nH --cut-dirs=3 --content-disposition https://demo.dataverse.org/api/datasets/${ID}/dirindex/
# or
wget -r -e robots=off -nH --cut-dirs=3 --content-disposition https://demo.dataverse.org/api/datasets/:persistentId/dirindex?persistentId=doi:${PERSISTENT_ID}

.. note:: In addition to the files and folders in the dataset, the command line above will also save the directory index of each folder, in a separate folder "dirindex".

Expand Down Expand Up @@ -3487,5 +3492,3 @@ Recursively applies the role assignments of the specified Dataverse collection,
GET http://$SERVER/api/admin/dataverse/{dataverse alias}/addRoleAssignmentsToChildren

Note: setting ``:InheritParentRoleAssignments`` will automatically trigger inheritance of the parent Dataverse collection's role assignments for a newly created Dataverse collection. Hence this API call is intended as a way to update existing child Dataverse collections or to update children after a change in role assignments has been made on a parent Dataverse collection.