Dominodatalab-data REST API Package Compatibility

Version

5.0.x, 5.1.x, 5.2.x

Issue:

The new dominodatalab-data api package (aka Domino Data api) that is available on pypi.org, has strict compatibility requirements with different versions of Domino 5.x.  Failing to use the correct version may generate spurious errors in your code such as:

Traceback (most recent call last):
  File "main.py", line 10, in <module>
    object_store = DataSourceClient().get_datasource("my_s3")
  File "/opt/conda/lib/python3.8/site-packages/domino_data/data_sources.py", line 798, in get_datasource
    response = get_datasource_by_name.sync_detailed(
  File "/opt/conda/lib/python3.8/site-packages/datasource_api_client/api/datasource/get_datasource_by_name.py", line 101, in sync_detailed
    return _build_response(response=response)
  File "/opt/conda/lib/python3.8/site-packages/datasource_api_client/api/datasource/get_datasource_by_name.py", line 70, in _build_response
    parsed=_parse_response(response=response),
  File "/opt/conda/lib/python3.8/site-packages/datasource_api_client/api/datasource/get_datasource_by_name.py", line 39, in _parse_response
    response_200 = DatasourceDto.from_dict(response.json())
  File "/opt/conda/lib/python3.8/site-packages/datasource_api_client/models/datasource_dto.py", line 100, in from_dict
    auth_type = DatasourceDtoAuthType(d.pop("authType"))
KeyError: 'authType'

Resolution:

Make sure you are using the correct version of this API for your version of Domino.  The versions are documented in the Domino docset, for example:

https://docs.dominodatalab.com/en/5.0/api_guide/140b48/domino-data-api/

But the compatibility is noted here for current versions of Domino

Notes/Information:

You can install the latest version of the library: 

python -m pip install dominodatalab-data

or you can specify a version, for example 0.2.0 via:
python -m pip install dominodatalab-data==0.2.0

You can confirm the version via pip freeze | grep -i domino-data

Be sure to check Domino documentation if your version is not listed here yet.