Skip to content

Commit

Permalink
changed the guide to reflect the fact that the includeFiles flag defa…
Browse files Browse the repository at this point in the history
…ults to "true". (#9763)
  • Loading branch information
landreev committed Sep 6, 2023
1 parent b74affc commit 2324fe1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/sphinx-guides/source/api/native-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -830,7 +830,7 @@ The fully expanded example above (without environment variables) looks like this

.. code-block:: bash
curl "https://demo.dataverse.org/api/datasets/24/versions?includeFiles=true"
curl "https://demo.dataverse.org/api/datasets/24/versions"
It returns a list of versions with their metadata, and file list:

Expand Down Expand Up @@ -883,7 +883,7 @@ It returns a list of versions with their metadata, and file list:
]
}
The optional ``includeFiles`` parameter specifies whether the files should be listed in the output. It defaults to ``false``. (Note that for a dataset with a large number of versions and/or files having the files included can dramatically increase the volume of the output). A separate ``/files`` API can be used for listing the files, or a subset thereof in a given version.
The optional ``includeFiles`` parameter specifies whether the files should be listed in the output. It defaults to ``true``, preserving backward compatibility. (Note that for a dataset with a large number of versions and/or files having the files included can dramatically increase the volume of the output). A separate ``/files`` API can be used for listing the files, or a subset thereof in a given version.

The optional ``offset`` and ``limit`` parameters can be used to specify the range of the versions list to be shown. This can be used to paginate through the list in a dataset with a large number of versions.

Expand All @@ -899,15 +899,15 @@ Get Version of a Dataset
export ID=24
export VERSION=1.0
curl "$SERVER_URL/api/datasets/$ID/versions/$VERSION"
curl "$SERVER_URL/api/datasets/$ID/versions/$VERSION?includeFiles=false"
The fully expanded example above (without environment variables) looks like this:

.. code-block:: bash
curl "https://demo.dataverse.org/api/datasets/24/versions/1.0"
curl "https://demo.dataverse.org/api/datasets/24/versions/1.0?includeFiles=false"
The optional ``includeFiles`` parameter specifies whether the files should be listed in the output (defaults to ``false``). Note that a separate ``/files`` API can be used for listing the files, or a subset thereof in a given version.
The optional ``includeFiles`` 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.


.. _export-dataset-metadata-api:
Expand Down

0 comments on commit 2324fe1

Please sign in to comment.