-
Notifications
You must be signed in to change notification settings - Fork 93
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
Added Two Convenience Functions to Return Version Data #64
Conversation
…ons. Also added tests, server responses and docs.
Ohh and in the future should I make pull requests to dev or master. Wasn't really sure what dev was being used for. |
2 similar comments
… preserves compat
Made one other minor (non-functional) change. Since the deleted API doesn't respect the limit param it is best not to send it by default. |
Retrieving Version Information | ||
=================== | ||
|
||
The Zotero API recommends requesting version information for all (or all changed) items and collections when implementing syncing. The following convience methods simplify this process. Note that by default these methods impose no limit on the number of items/collection versions returned. To retrieve only the versions of items changed after a given version use the since search/request parameter. |
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.
Can we clarify what the since / search parameter is? I think it should be rendered as code
, and include a link to https://www.zotero.org/support/dev/web_api/v3/syncing
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.
Sure, it is covered briefly in your stuff on search parameters but it could be more clear. I'll make the change.
PRs should be made against |
Added two convenience functions to return the item and collection versions. Also added tests, server responses and docs.
You might want to view the docs to make sure I got the formatting right.
Yes, my spelling in the branch name and commit message is atrocious.