cbapi-python icon indicating copy to clipboard operation
cbapi-python copied to clipboard

Document PUT usage with examples

Open nlariviere2 opened this issue 6 years ago • 0 comments

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).

nlariviere2 avatar Mar 18 '19 21:03 nlariviere2