Stream: community

Topic: Question about dataverse validation

Yuchen Huang (Jul 24 2025 at 12:59):

Hello!

I have a few questions regarding the validation process when using the Dataverse API.

Whenever I push a dataset via the API, a dataset will be created if its valid. However, is it possible to validate the dataset through the API without creating it?

Additionally, I assume that JSON schema is used for the validation process (please correct me if I'm wrong), is it possible to access the schema via the API?

If the answer to the above is no, would it be possible to implement or extend the API with such endpoints?

Thanks in advance!

Philip Durbin 🚀 (Jul 24 2025 at 13:01):

Let's see, I know @Steven Winship worked on a related pull request:

Improved JSON Schema validation for datasets #10543

Philip Durbin 🚀 (Jul 24 2025 at 13:02):

@Yuchen Huang have you tried these?

• https://guides.dataverse.org/en/6.7/api/native-api.html#retrieve-a-dataset-json-schema-for-a-collection
• https://guides.dataverse.org/en/6.7/api/native-api.html#validate-dataset-json-file-for-a-collection

Yuchen Huang (Jul 24 2025 at 13:06):

Oh great! We are still at v6.3, I guess it's time for an upgrade. Thank you!

Philip Durbin 🚀 (Jul 24 2025 at 13:07):

You can try these: :smile:

• https://guides.dataverse.org/en/6.3/api/native-api.html#retrieve-a-dataset-json-schema-for-a-collection
• https://guides.dataverse.org/en/6.3/api/native-api.html#validate-dataset-json-file-for-a-collection

Yuchen Huang (Jul 24 2025 at 13:09):

This is even better! I will have a look, thank you!

Philip Durbin 🚀 (Jul 24 2025 at 13:10):

Sure, please let us know how they work out for you. Here was the original feature request by @Oliver Bertuch: https://github.com/IQSS/dataverse-pm/issues/26

Last updated: Nov 01 2025 at 14:11 UTC