search

smartcar / python-sdk

Smartcar Python SDK
MIT License
44 stars 13 forks source link

Vehicle.disconnect() does not return value #86

Closed dbartenstein closed 2 years ago

dbartenstein commented 3 years ago

According to Smartcar’s API reference, disconnect should return a value (dict with key status): https://smartcar.com/docs/api?language=Python#delete-disconnect

Obviously there is no return value: https://github.com/smartcar/python-sdk/blob/3d84b894b04d9d0b1145135c1947b54fb51c759b/smartcar/vehicle.py#L100

gurpreetatwal commented 3 years ago

Hi @dbartenstein! :wave:

Unfortunately that's actually an issue with the formatting of docs/api rather than the SDK itself. The "Example response" section of the docs is not affected by the SDK selector as of right now so it always just shows the HTTP response body. The response types for the Python SDK are documented in the README.

We have an internal ticket to fix up the "Example response" section to clear up this confusion.

gurpreetatwal commented 2 years ago

This was resolved as a part of our revamp of the SDK in #97 and we've updated the API reference to make it more clear that the example response body is meant for the HTTP interface.