-
Notifications
You must be signed in to change notification settings - Fork 490
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
add beginner friendly API documentation #6086 #6107
Conversation
Can one of the admins verify this patch? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this was demo in front of a live audience, I trust the content is sound and the code examples accurate. Focused review on formatting and other minor details like typo's. Will spare @pdurbin from fixing those. Approving and quickly following up with commit resolve any and all typos. Overall a great improvement to our guides. 👍
Fixed typo's and other small details as promised. Ready for QA. |
@mheppler thanks for fixing those typos! |
|
||
See the :doc:`/api/intro` section of the API Guide for a high level overview of Dataverse APIs. Below are listed problems that support teams might encounter that can be handled via API (sometimes only via API). | ||
|
||
A Dataset Is Locked And Cannot Be Edited or Published |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be helpful to point out that one should be certain Dataverse is finished with a dataset (worst case: stop glassfish) before removing the lock.
|
||
Depending on how open your installation of Dataverse is to the general public creating datasets, you may sometimes need to deal with spam datasets. | ||
|
||
Look for "destroy" in the :doc:`/api/native-api` section of the API Guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Point out that unpublished datasets may be deleted via http://guides.dataverse.org/en/latest/api/native-api.html#delete-unpublished-dataset ?
How to Get an API Token | ||
----------------------- | ||
|
||
Your API token is unique to the server you are using. You cannot take your API token from one server and use it on another server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/server/Dataverse instance/g ?
How Your API Token Is Like a Password | ||
------------------------------------- | ||
|
||
Anyone who has your API Token can add and delete data as you so you should treat it with the same care as a password. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... add and delete data with your credentials, so you should ?
api/dataverses/$id/metadatablocks
API endpoint #3624 correct docs forapi/dataverses/$id/metadatablocks
API endpointTo give feedback on this pull request, you are welcome to look at the following build of the guides:
http://guides.dataverse.org/en/6086-api-guide/api/intro.html
Here's a screenshot of the re-written "intro" page as of 39cd360
Update for 2019-08-20:
POST
commands where you need to send JSON or whatever. I hope people like the way I'm documenting things now in the files I touched, with Bashexport
commands for environment variables used in curl commands. Now color coded! Now with lines that wrap! 😄