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

Document PUT usage with examples #139

Open
nlariviere2 opened this issue Mar 18, 2019 · 0 comments
Open

Document PUT usage with examples #139

nlariviere2 opened this issue Mar 18, 2019 · 0 comments

Comments

@nlariviere2
Copy link

Most of the REST API examples included in Github and cbapi.readthedocs.io show GET usage and what is returned, but there are very few examples showing PUT methods for updating sensors and sensor groups, for example.

PUT methods may require different parameters in the JSON payload that might not be documented. For example, I tried to update a sensor ID with {"uninstall": "true"} but it also required that I include "groupid" or it would throw a traceback.

Could you add some more robust documentation around using PUT, POST, or DELETE methods for sensors and sensor groups (or everywhere) with examples using curl (for REST API).

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

No branches or pull requests

1 participant