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: 'Getting File Metadata' section #6657

Conversation

pkiraly
Copy link
Member

@pkiraly pkiraly commented Feb 17, 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 'Getting File Metadata' 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 (e.g. #6600). This one is about reformatting a file API call.

Suggestions on how to test this:

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

Check 'Getting File Metadata' section

Does this PR introduce a user interface change?: no

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

Additional documentation: no

@coveralls
Copy link

coveralls commented Feb 17, 2020

Coverage Status

Coverage increased (+0.02%) to 19.471% when pulling 34f6376 on pkiraly:6083-documentation-update-native-API-examples-getting-file-metadata into be6678b on IQSS:develop.

Copy link
Contributor

@mheppler mheppler left a comment

Choose a reason for hiding this comment

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

Everything looks good here, just added an inline comment (line 1785) proposing a simple text change.

doc/sphinx-guides/source/api/native-api.rst Outdated Show resolved Hide resolved
@mheppler mheppler assigned pkiraly and unassigned mheppler Feb 18, 2020
@djbrooke djbrooke moved this from Code Review 🦁 to Community Dev 💻❤️ in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Feb 19, 2020
@pkiraly pkiraly removed their assignment Feb 20, 2020
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Community Dev 💻❤️ to QA Feb 20, 2020
@kcondon kcondon self-assigned this Feb 20, 2020
@kcondon kcondon merged commit 2f6b9e8 into IQSS:develop Feb 20, 2020
@djbrooke djbrooke added this to the 4.20 milestone Feb 20, 2020
@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
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants