Added tabulartags in files metadata for files metadata

[saikiranpatil]

What this PR does / why we need it:
correcting the API Guide for update Request where TabularTags is required in the Request Header

Which issue(s) this PR closes:

• Closes Feature Request: API Guide add docs about how to update tabularTags in the files metadata #9864

[pdurbin]

@saikiranpatil thanks for the PR!

I dug up what I had sent @MellyGray in Slack.

She wrote:

curl -H "X-Dataverse-key:1967e628-3bf4-4bc1-abe9-711f45b9b6b9" -X POST \ -F 'jsonData={"description":"My description bbb.","provFreeform":"Test prov freeform","tabularTags":["Survey"],"restrict":false}' \ "http://localhost:8000/api/files/1453/metadata"

And I said, please try dataFileTags instead of tabularTags in your JSON. That’s what I’m seeing here: https://github.com/IQSS/dataverse/blob/v5.14/src/main/java/edu/harvard/iq/dataverse/datasetutility/OptionalFileParams.java#L60

Pretty printed (easier to read), the fixed version looks like this:

{
  "description": "My description bbb.",
  "provFreeform": "Test prov freeform",
  "dataFileTags": [
    "Survey"
  ],
  "restrict": false
}

(For this pull request, it's best to keep it on one line, though.)

Please make sure all JSON is valid and please watch the single quotes.

You can test against https://demo.dataverse.org if you like! If you have questions, please feel free to ask here or open a topic in #dev at https://chat.dataverse.org . Thanks!

[pdurbin]

The single quote on the right should be on the outside.

[saikiranpatil]

my bad, I should have rechecked before commit. i will correct them

[pdurbin]

This does not parse as valid JSON. Please try it (and the others) at https://jsonlint.com (or your favorite validator):

[saikiranpatil]

hey @pdurbin, i have made changes, are there any mistake in that?

[pdurbin]

@saikiranpatil I haven't checked the JSON but overall I think it's looking better. Probably we'll want to keep the "categories" in the JSON because it's different that tabular tags. I can add it back if you want. Please just let me know.

[pdurbin]

@saikiranpatil oh, also, do you want to try testing your curl commands at https://demo.dataverse.org ? To make sure they work?

[saikiranpatil]

@pdurbin I added back "categories", I am not sure how to check commands at https://demo.dataverse.org/, but I checked JSON, it's in correct JSON format.

[pdurbin]

@saikiranpatil to check the curl commands you would open a terminal and execute them. I know you have them in front of you but here's an HTML preview in case you haven't been building the HTML version: https://dataverse-guide--10027.org.readthedocs.build/en/10027/api/native-api.html#updating-file-metadata

The demo server is already used in the example:

curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X POST \
  -F 'jsonData={"description":"My description bbb.","provFreeform":"Test prov freeform","categories":["Data"],"dataFileTags":["Survey"],"restrict":false}' \
  "http://demo.dataverse.org/api/files/24/metadata"

To get an API token you would create an account on https://demo.dataverse.org and follow these steps:
https://dataverse-guide--10027.org.readthedocs.build/en/10027/user/account.html#how-to-create-your-api-token

Before running the curl command you'll want to create a dataset, upload a file, and figure out the file id (instead of 24 in the example above). The easiest way is to edit the permissions on the file and look for the file id in the URL.

Does that make sense?

[saikiranpatil]

@pdurbin got it. Are there are any changes required in PR?

[pdurbin]

@saikiranpatil I haven't tested it so I'm not sure. Did you test it?

[saikiranpatil]

I am totally new to this, I have created account, uploaded file as

and used the id as 2102722 from the image,
upon request i got as

did I take the ID incorrectly?

[pdurbin]

Huh. From a quick look it seems right. 🤔 Can you please try changing the jsonData? Maybe you could try simplifying it all the way down to just changing the description:

'jsonData={"description":"My description bbb."}'

Another sanity check, using your API token, can you get the metadata for the files? Like this:

curl -H "X-Dataverse-key:xxxxx" https://demo.dataverse.org/api/files/2102722/metadata

You could also try a published file without a key:

curl https://demo.dataverse.org/api/files/2102661/metadata gives me this:

{"label":"ardour.desktop","restricted":false,"id":1897048}

[saikiranpatil]

again tried this

even this is not working

[pdurbin]

Weird. You seem to be using https://reqbin.com/curl

This one works for me:

[saikiranpatil]

maybe, it's problem with my way of uploading file.
does the changes made in the documentation works correctly, i am unable to test it.

[pdurbin]

When I get to a good stopping point, I'll play with it. Thanks and have a good weekend!

[saikiranpatil]

@pdurbin if the changes made in documentation are working correctly, please merge PR.

[pdurbin]

I haven't tested this but it should work. Sending to ready for QA.

[pdurbin]

@saikiranpatil merged! Thanks for the pull request! ❤️