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

Added Two Convenience Functions to Return Version Data #64

Merged
merged 3 commits into from
Jan 11, 2017

Conversation

TruePath
Copy link
Contributor

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.

…ons. Also added tests, server responses and docs.
@TruePath
Copy link
Contributor Author

Ohh and in the future should I make pull requests to dev or master. Wasn't really sure what dev was being used for.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.9%) to 41.875% when pulling 8241fac on TruePath:add_verion_functions into 5797cfb on urschrei:master.

2 similar comments
@coveralls
Copy link

Coverage Status

Coverage increased (+0.9%) to 41.875% when pulling 8241fac on TruePath:add_verion_functions into 5797cfb on urschrei:master.

@coveralls
Copy link

coveralls commented Jan 11, 2017

Coverage Status

Coverage increased (+0.9%) to 41.875% when pulling 8241fac on TruePath:add_verion_functions into 5797cfb on urschrei:master.

@TruePath
Copy link
Contributor Author

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.

@coveralls
Copy link

coveralls commented Jan 11, 2017

Coverage Status

Coverage increased (+0.8%) to 41.745% when pulling 1927ef4 on TruePath:add_verion_functions into 5797cfb on urschrei:master.

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.
Copy link
Owner

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

Copy link
Contributor Author

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.

@urschrei
Copy link
Owner

PRs should be made against dev (as per CONTRIBUTING.md), but it doesn't matter, since they're currently equal anyway. I'll build the docs and make sure they're rendering OK…

@coveralls
Copy link

coveralls commented Jan 11, 2017

Coverage Status

Coverage increased (+0.8%) to 41.745% when pulling 5c03e09 on TruePath:add_verion_functions into 5797cfb on urschrei:master.

@urschrei urschrei merged commit 5c03e09 into urschrei:master Jan 11, 2017
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.

None yet

3 participants