balena-io / balena-sdk-python

Balena SDK for Python
Apache License 2.0
68 stars 46 forks source link

Supervisor Functions list app_id and device_uuid as optional #77

Open hunterjackson opened 6 years ago

hunterjackson commented 6 years ago

Documentation link: https://github.com/resin-io/resin-sdk-python/blob/master/DOCUMENTATION.md#supervisor

Code that makes them both mandatory: https://github.com/resin-io/resin-sdk-python/blob/master/resin/models/supervisor.py#L39-L44

nghiant2710 commented 6 years ago

@hunterjackson So sorry that our docs leads to misunderstandings, they're marked as optional since if you call these functions from inside application container then you don't need to pass these parameters while they're mandatory if called outside application container.

We will update our docs to fix the misunderstandings, thanks for raising this issue.

hunterjackson commented 6 years ago

Curious as if I simply comment out the lines checking for those parameters and raising an error if they're not there, only one of the parameters are needed and the function I tested works fine.

On Tue, Apr 3, 2018, 11:16 PM Trong Nghia Nguyen notifications@github.com wrote:

@hunterjackson https://github.com/hunterjackson So sorry that our docs leads to misunderstandings, they're marked as optional since if you call these functions from inside application container then you don't need to pass these parameters while they're mandatory if called outside application container.

We will update our docs to fix the misunderstandings, thanks for raising this issue.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/resin-io/resin-sdk-python/issues/77#issuecomment-378492014, or mute the thread https://github.com/notifications/unsubscribe-auth/AGhwyoKjQX5V64LsBPzNjOb2-tFZT4asks5tlGUKgaJpZM4S7yr4 .

-- Hunter Jackson Data Engineer Sight Machine hjackson@sightmachine.com M: +1-863-255-7155