diff --git a/doc/release-notes/10888-add-api-for-comparing-dataset-versions.md b/doc/release-notes/10888-add-api-for-comparing-dataset-versions.md index f9b3822d29d..b82441ee11a 100644 --- a/doc/release-notes/10888-add-api-for-comparing-dataset-versions.md +++ b/doc/release-notes/10888-add-api-for-comparing-dataset-versions.md @@ -3,6 +3,8 @@ The following API have been added: /api/datasets/{persistentId}/versions/{versionId0}/compare/{versionId1} This API lists the changes between 2 dataset versions. The Json response shows the changes per field within the Metadata block and the Terms Of Access. Also listed are the files that have been added or removed. Files that have been modified will also display the new file data plus the fields that have been modified. +When compare includes an unpublished/draft version the api token must be associated with a user having view unpublished privileges +An error will be returned if VERSION0 was not created before VERSION1 Example of Metadata Block field change: ```json