Skip to content

Commit

Permalink
update api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
qqmyers committed Feb 15, 2025
1 parent 743d799 commit 5abf460
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/sphinx-guides/source/api/curation-labels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Dataset Curation Status API
When the :ref:`:AllowedCurationLabels <:AllowedCurationLabels>` setting has been used to define Curation Labels, this API can be used to set these labels on draft datasets.
Superusers can define which set of labels are allowed for a given datasets in a collection/an individual dataset using the api described in the :doc:`/admin/dataverses-datasets` section.
The API here can be used by curators/those who have permission to publish the dataset to get/set/change/delete the label currently assigned to a draft dataset.
If the :ref:`dataverse.api.show-curation-status-to-all` flag is enabled, users who can see the draft dataset version can use the get API call.

This functionality is intended as a mechanism to integrate the Dataverse software with an external curation process/application: it is a way to make the state of a draft dataset,
as defined in the external process, visible within Dataverse. These labels have no other effect in Dataverse and are only visible to curators/those with permission to publish the dataset.
Expand Down

0 comments on commit 5abf460

Please sign in to comment.