Inconsistent behaviour of dataset delete API

[stevenwinship]

What this PR does / why we need it: API call of delete Dataset does not match what has been documented. Superuser must use /destroy to delete a released Dataset. Delete Dataset API should only work for "Draft" datasets.

Which issue(s) this PR closes: #11253

• Closes Inconsistent behaviour of dataset delete API #11253

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?: Included

Additional documentation:

[coveralls]

Coverage is 25.012% — 11253-inconsistent-dataset-delete-api into develop. No base build found for develop.

[qqmyers]

From QA: This appears to now work as discussed in the issue, which I think continues to be inconsistent with the documentation. When published version(s) and a draft exist, the Delete Unpublished Dataset API just deletes the draft and doesn't fail because the dataset has been published.

I'd suggest one of two changes:

1. make this only work if there is only a draft, or
2. adjust the docs to make it "Delete Unpublished Dataset Changes" and explain it removes a draft version (and metadata changes and deletes any files added in the draft) which results in deletion of the dataset if there are no published versions.

If it always deletes a draft (if one exists) - i.e. option 2, it's more of a duplicate of the DELETE /api/datasets/versions/{versionId} call (which, despite the signature, only works on drafts), so limiting this call to truly deleting unpublished datasets only might be more useful, but it's a bigger backward incompatible change. Option 2 also results in redundant code if there's no clean-up.

I'm not sure what the process should be to make a choice - perhaps just standup discussion?

Also - the PR doesn't update the change log to note the backward incompatibility (for superusers only at present).

Otherwise - the api does remove the draft, delete draft only files and not files in published versions, does redirect superusers to the destroy api as intended.

[stevenwinship]

@qqmyers @pdurbin I added to the native api and changelog docs. Please take a look

[sonarqubecloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

[github-actions]

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11253-inconsistent-dataset-delete-api

ghcr.io/gdcc/configbaker:11253-inconsistent-dataset-delete-api

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

[pdurbin]

We discussed this yesterday and I suggested to @qqmyers that he could make a fresh pull request show how he thinks the APIs should change. He said he would but no rush! As discussed, this is not a must have.

[qqmyers]

#12639 extends/replaces this PR.