Skip to content

Commit 6bf262f

Browse files
authored
Get Citation API docs: fix typo, link to version spec #10257 (#11290)
1 parent eb8e91d commit 6bf262f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3332,17 +3332,17 @@ This API call returns the dataset citation as seen on the dataset page, wrapped
33323332
export PERSISTENT_IDENTIFIER=doi:10.5072/FK2/YD5QDG
33333333
export VERSION=1.0
33343334
3335-
curl -H "Accept:application/json" "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/{version}/citation?persistentId=$PERSISTENT_IDENTIFIER"
3335+
curl -H "Accept:application/json" "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/citation?persistentId=$PERSISTENT_IDENTIFIER"
33363336
3337-
By default, deaccessioned dataset versions are not included in the search when applying the :latest or :latest-published identifiers. Additionally, when filtering by a specific version tag, you will get a "not found" error if the version is deaccessioned and you do not enable the ``includeDeaccessioned`` option described below.
3337+
See :ref:`dataset-version-specifiers` for how to specify a version. By default, deaccessioned dataset versions are not included in the search when applying the :latest or :latest-published identifiers. Additionally, when filtering by a specific version tag, you will get a "not found" error if the version is deaccessioned and you do not enable the ``includeDeaccessioned`` option described below.
33383338

33393339
If you want to include deaccessioned dataset versions, you must set ``includeDeaccessioned`` query parameter to ``true``.
33403340

33413341
Usage example:
33423342

33433343
.. code-block:: bash
33443344
3345-
curl -H "Accept:application/json" "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/{version}/citation?persistentId=$PERSISTENT_IDENTIFIER&includeDeaccessioned=true"
3345+
curl -H "Accept:application/json" "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/citation?persistentId=$PERSISTENT_IDENTIFIER&includeDeaccessioned=true"
33463346
33473347
Get Citation In Other Formats
33483348
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -3360,7 +3360,7 @@ Usage example:
33603360
export VERSION=1.0
33613361
export FORMAT=EndNote
33623362
3363-
curl "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/{version}/citation/$FORMAT?persistentId=$PERSISTENT_IDENTIFIER"
3363+
curl "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/citation/$FORMAT?persistentId=$PERSISTENT_IDENTIFIER"
33643364
33653365
By default, deaccessioned dataset versions are not included in the search when applying the :latest or :latest-published identifiers. Additionally, when filtering by a specific version tag, you will get a "not found" error if the version is deaccessioned and you do not enable the ``includeDeaccessioned`` option described below.
33663366

@@ -3370,7 +3370,7 @@ Usage example:
33703370

33713371
.. code-block:: bash
33723372
3373-
curl "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/{version}/citation/$FORMAT?persistentId=$PERSISTENT_IDENTIFIER&includeDeaccessioned=true"
3373+
curl "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/citation/$FORMAT?persistentId=$PERSISTENT_IDENTIFIER&includeDeaccessioned=true"
33743374
33753375
33763376
Get Citation by Preview URL Token

0 commit comments

Comments
 (0)