Skip to content

Commit 2165d6b

Browse files
committed
docs: clarify dataset fields consistency across dataset versions in API guide #11573
Added a note explaining the constancy of `datasetId`, `datasetPersistentId`, and `datasetType` fields for all dataset versions in the API documentation. The first two have been around since v4.18, see also issue #6397
1 parent d6cf0a3 commit 2165d6b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1583,6 +1583,9 @@ The fully expanded example above (without environment variables) looks like this
15831583
15841584
curl "https://demo.dataverse.org/api/datasets/24/versions/1.0?excludeFiles=false"
15851585
1586+
Note: the data object will contain the fields ``datasetId``, ``datasetPersistentId`` (since `4.18 <https://github.com/IQSS/dataverse/issues/6397>`_) and ``datasetType`` (since `6.7 <https://github.com/IQSS/dataverse/issues/11573>`_).
1587+
All of these fields are equal and constant for all versions of a dataset.
1588+
15861589
The optional ``excludeFiles`` parameter specifies whether the files should be listed in the output (defaults to ``true``). Note that a separate ``/files`` API can be used for listing the files, or a subset thereof in a given version.
15871590

15881591
.. code-block:: bash

0 commit comments

Comments
 (0)