Skip to content

Comments

docs: fix JSON payload format in deleteFiles API example (fixes #11896)#11946

Merged
stevenwinship merged 2 commits intoIQSS:developfrom
juriroemer:patch-1
Nov 5, 2025
Merged

docs: fix JSON payload format in deleteFiles API example (fixes #11896)#11946
stevenwinship merged 2 commits intoIQSS:developfrom
juriroemer:patch-1

Conversation

@juriroemer
Copy link
Contributor

Updated the API documentation to correct the format of the deleteFiles payload.

What this PR does / why we need it:
The current API documentation for deleting files is wrong

Which issue(s) this PR closes:

…S#11896)

Updated the API documentation to correct the format of the `deleteFiles` payload.
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't test this (we should before merging) but the fix seems to match what's described in the issue. Thanks, @juriroemer! Sending to QA.

@github-project-automation github-project-automation bot moved this to Ready for QA ⏩ in IQSS Dataverse Project Nov 3, 2025
@juriroemer
Copy link
Contributor Author

Thanks, much appreciated!

This gave me a bit of an headache last week, until I came across the issue. I've tested the described (updated) API call that only has the list as request body against demo.dataverse.org and that worked flawlessly. The generated test-docs also look good to me 🙏 :)

@stevenwinship stevenwinship self-assigned this Nov 5, 2025
@stevenwinship stevenwinship moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Nov 5, 2025
@stevenwinship
Copy link
Contributor

Verified the doc change matches the code

@stevenwinship stevenwinship merged commit 78e8241 into IQSS:develop Nov 5, 2025
7 of 8 checks passed
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Nov 5, 2025
@stevenwinship stevenwinship removed their assignment Nov 5, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Nov 5, 2025
@pdurbin pdurbin added this to the 6.9 milestone Nov 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

Documentation: from v 6.7.1 Correct samples for API deleteFiles

3 participants