Skip to content

Commit 10f3b5d

Browse files
committed
fix: fix incorrect URL + typos in docs for pidReconcile API
1 parent 7971dfb commit 10f3b5d

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3381,29 +3381,28 @@ The API can also be used to reset the dataset to use the default/inherited value
33813381
33823382
The default will always be the same provider as for the dataset PID if that provider can generate new PIDs, and will be the PID Provider set for the collection or the global default otherwise.
33833383
3384-
Reconcile the PID ofa a dataset (If multiple PIDProvider are Enabled)
3385-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3384+
Reconcile The PID of a Dataset (If Multiple PID Providers Are Enabled)
3385+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3386+
33863387
Dataverse can be configured to use multiple PID Providers (see the :ref:`pids-configuration` section for more information).
3387-
It is possible to update the PIDProvider used by a dataset and assign the dataset (and any PIDs currently assigned to
3388-
the dataset's files) a new PID that uses the protocol/authority/separator/shoulder of the new PIDProvider. This API 'reconciles'
3389-
a draft dataset's PID by creating a new PID supported by the PidProvider and assigning the original PID as an
3388+
It is possible to update the PID Provider used by a dataset and assign the dataset (and any PIDs currently assigned to
3389+
the dataset's files) a new PID that uses the protocol/authority/separator/shoulder of the new PID Provider. This API 'reconciles'
3390+
a draft dataset's PID by creating a new PID supported by the PID Provider and assigning the original PID as an
33903391
alternativePersistentIdentifier for the dataset. The API is restricted to datasets that have not already been published.
3391-
(It does not make any changes to any PidProvider.) Note that this change does not affect the storage repository where the
3392-
old identifier is still used. n(An administrator could move the files manually and set the storagelocationdesignator to
3392+
(It does not make any changes to any PID Provider.) Note that this change does not affect the storage repository where the
3393+
old identifier is still used. (An administrator could move the files manually and set the storagelocationdesignator to
33933394
false on the entry in the alternativepersistentidentifier table for the old identifier if this is a concern. This is not
33943395
necessary for Dataverse to function correctly.)
33953396
3396-
The PID Provider id used must be one of the those configured - see :ref:`pids-providers-api`.
3397-
3398-
To reconcile the PID of the dataset:
3397+
To reconcile the PID of a dataset:
33993398
34003399
.. code-block:: bash
34013400
34023401
export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
34033402
export SERVER_URL=https://demo.dataverse.org
34043403
export PERSISTENT_IDENTIFIER=doi:10.5072/FK2/YD5QDG
34053404
3406-
curl -X PUT -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/datasets/$PERSISTENT_IDENTIFIER/pidReconcile/"
3405+
curl -X PUT -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/datasets/:persistentId/pidReconcile?persistentId=$PERSISTENT_IDENTIFIER"
34073406
34083407
.. _api-dataset-types:
34093408

src/main/java/edu/harvard/iq/dataverse/api/Datasets.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5108,7 +5108,7 @@ public Response getCanDownloadAtLeastOneFile(@Context ContainerRequestContext cr
51085108

51095109
@PUT
51105110
@AuthRequired
5111-
@Path("{identifier}/pidReconcile/")
5111+
@Path("{identifier}/pidReconcile")
51125112
public Response reconcilePid(@Context ContainerRequestContext crc, @PathParam("identifier") String datasetId) throws WrappedResponse {
51135113

51145114
// Superuser-only:

0 commit comments

Comments
 (0)