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.

Sign up for GitHub

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

Jump to bottom

Documentation for Planktos API #49

Closed

georgeaf99 opened this issue Feb 16, 2017 · 1 comment

Labels

task

Collaborator

georgeaf99 commented Feb 16, 2017

The public API is quite simple; however, it is not clear what our contracts to the user are.

For example:

getSnapshot not only gets the latest snapshot, but it also seeds the file if it wasn't being seeded before
getSnapshot can only be called after update
fetch and getFile have the same side effects and constraints as getSnapshot

Some of this may be a problem with our API; however, documentation is necessary regardless of whether or not these are issues.

The text was updated successfully, but these errors were encountered:

georgeaf99 added the task label

Owner

xuset commented Feb 26, 2017 •

edited

Loading

Api documentation is now on the wiki and the api problems were (for the most part) fixed in #51 😄

xuset closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment