Skip to content

Commit 879c465

Browse files
committed
give downloaders more hints to find the guestbookId #12001
1 parent 05a961e commit 879c465

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

doc/sphinx-guides/source/api/changelog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This API changelog is experimental and we would love feedback on its usefulness.
99

1010
v6.10
1111
-----
12-
- The following GET APIs will now return ``400`` if a required Guestbook Response is not supplied. A Guestbook Response can be passed to these APIs in the JSON body using a POST call.
12+
- The following GET APIs will now return ``400`` if a required Guestbook Response is not supplied. A Guestbook Response can be passed to these APIs in the JSON body using a POST call. See the notes under :ref:`basic-file-access` and :ref:`download-by-dataset-by-version` for details.
1313

1414
- **/api/access/datafile/{fileId:.+}**
1515

@@ -19,7 +19,7 @@ v6.10
1919

2020
- **/api/access/dataset/{id}/versions/{versionId}**
2121

22-
- The following POST APIs will now return ``400`` if a required Guestbook Response is not supplied. A Guestbook Response can be passed to these APIs in the JSON body.
22+
- The following POST APIs will now return ``400`` if a required Guestbook Response is not supplied. A Guestbook Response can be passed to these APIs in the JSON body. See the note under :ref:`basic-download-by-dataset` for details.
2323

2424
- **/api/access/datafiles**
2525

doc/sphinx-guides/source/api/dataaccess.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Please note that in addition to the files from dataset, an additional file call
2727

2828
There are two forms of the "download by dataset" API, a basic form and one that supports dataset versions.
2929

30+
.. _basic-download-by-dataset:
31+
3032
Basic Download By Dataset
3133
~~~~~~~~~~~~~~~~~~~~~~~~~
3234

@@ -50,6 +52,8 @@ The fully expanded example above (without environment variables) looks like this
5052
5153
curl -L -O -J -H X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx https://demo.dataverse.org/api/access/dataset/:persistentId/?persistentId=doi:10.70122/FK2/N2XGBJ
5254
55+
.. _download-by-dataset-by-version:
56+
5357
Download By Dataset By Version
5458
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5559

@@ -82,6 +86,8 @@ The fully expanded example above (without environment variables) looks like this
8286
8387
curl -O -J -H X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx https://demo.dataverse.org/api/access/dataset/:persistentId/versions/2.0?persistentId=doi:10.70122/FK2/N2XGBJ
8488
89+
.. _basic-file-access:
90+
8591
Basic File Access
8692
-----------------
8793

0 commit comments

Comments
 (0)