IDs are incompatibly typed: Sometimes strings, sometimes ints

For the Python SDK, it appears that there is some incompatible typing going on. This is for both SDK 3.1 and SDK 4.0.

Take folder_id, for example. In the model, the id is an Optional[str]; but in e.g. copy_look, it requires int. These issues cause mypy to fail when using the sdk. It’s hard to know whether or not the str and int types are always compatible; that is, if the id is present, whether it can be safely casted to a string. To start with, it might be helpful to document this in the SDK.

[joeldodge79]

@christippett the issue of id and parent_id being advertised as strings and coming back as integers in API version 3.1 and many similar discrepancies across other models is the main motivation we released API version 4.0 which behaves correctly (says string and sends string). I’d highly recommend using 4.0

we may change the spec for 3.1 in cases like this (and advertise an integer instead of a string, we’ll never change the actual returned value as that would be a breaking change) but it’s not a high priority so, again, 4.0 is your friend 😃

wrt to #520, that actually seems to be an issue with the RTL (run time library) and a patch to fix it would be most welcome!

[joeldodge79]

thanks for the report. I’m following up with the copy_look endpoint author to understand why they’re asking for an int instead of a string.