Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#6083 update examples in File part of Native API: 'Provenance' section. #6712

Conversation

pkiraly
Copy link
Member

@pkiraly pkiraly commented Mar 2, 2020

What this PR does / why we need it: It improves the Native API documentation by providing full curl examples for a File regarding call in 'Provenance' section
Which issue(s) this PR closes: none of them. It is an additional step for solving #6083

Special notes for your reviewer: This PR continue previous pull requests which handles examples regarding dataverses/datasets/files (e.g. #6600). In the "Create/Update Provenance JSON and provide related entity name for an uploaded file" it is not clear what is an entity name. The original text doesn't give any entity name, neither Dataverse source code at the API call, so I addedd an extra line:

  export ENTITY_NAME="..."

Please provide an entity name, and I change it.

Suggestions on how to test this:

cd doc/sphinx-guides
make clean && make html
firefox build/html/api/native-api.html

Check 'Provenance' section

Does this PR introduce a user interface change?: no

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

Additional documentation: no

@pkiraly
Copy link
Member Author

pkiraly commented Mar 2, 2020

Note: I added subheadings, because otherwise it is hard to follow what example belongs to what topic.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 19.444% when pulling 6265a4f on pkiraly:6083-documentation-update-native-API-examples-provenance-metadata into 036c78a on IQSS:develop.

@djbrooke djbrooke self-assigned this Mar 2, 2020
@djbrooke
Copy link
Contributor

djbrooke commented Mar 2, 2020

Thanks @pkiraly. The text looks fine, but I don't know the answer to your entity name question. I'll defer to one of the developers.

@djbrooke djbrooke assigned pdurbin and unassigned djbrooke Mar 2, 2020
@pdurbin pdurbin removed their assignment Mar 5, 2020
@sekmiller sekmiller self-assigned this Mar 6, 2020
@kcondon kcondon merged commit e03ba54 into IQSS:develop Mar 6, 2020
@kcondon kcondon self-assigned this Mar 6, 2020
@djbrooke djbrooke added this to the 4.20 milestone Mar 6, 2020
@pkiraly
Copy link
Member Author

pkiraly commented Mar 6, 2020

@sekmiller @djbrooke Wait a minute, I had a question, which was not answered: what is entity name? If we leave it as it is, I'll create a new issue asking it again, and when there will be answer, we should update this part.

@sekmiller
Copy link
Contributor

Sorry. The entity name is the name that links the provenance file to its data file in Dataverse. It gets saved to the datafile record in dataverse.

@pkiraly
Copy link
Member Author

pkiraly commented Mar 6, 2020

@sekmiller Could you tell me an example? Plus: an example JSON file also would be useful for the reader of these API calls.

@sekmiller
Copy link
Contributor

sekmiller commented Mar 6, 2020

I was just chatting with Kevin. He had a file that worked but given some code changes it no longer does. The developer who made the changes has left IQSS and I don't have anything at the moment. If you give me a little time I will get a working example for you.

@pkiraly
Copy link
Member Author

pkiraly commented Mar 6, 2020

Sure, take your time, and ping me when you have the info. I'll update the documentation accordingly.

@pkiraly
Copy link
Member Author

pkiraly commented Jun 24, 2021

This PR was developed by Göttingen eResearch Alliance, Germany, and funded by SSHOC, "Social Sciences and Humanities Open Cloud". SSHOC has received funding from the European Union’s Horizon 2020 project call H2020-INFRAEOSC-04-2018, grant agreement #823782.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants