v1.0.11

Remove certifi from requirements.txt to resolve version conflicts when updating requests to v2.33.0 in ingest-api

Full Changelog: v1.0.10...v1.0.11

v1.0.10

Add missing support to Publication and EPICollection types

What's Changed

• Derek furst/add epicollections by @DerekFurstPitt in #26
• reordered imports in init to avoid potential circular import by @DerekFurstPitt in #27

Full Changelog: v1.0.8...v1.0.10

v1.0.8

Update urls for documentation site

What's Changed

• Update urls for documentation site by @shirey in #25

Full Changelog: v1.0.7...v1.0.8

v1.0.7

Add two new endpoints from entity-api: GET /datasets/<id>/donors and GET /datasets/<id>/samples to support full prov metadata

Full Changelog: v1.0.5...v1.0.7

v1.0.5

Update update_entity() to only return the message. No more entity dict returned due to the recent entity-api PUT call update to mitigate performance issue.

v1.0.4

Add publication support

v1.0.3

Add methods to flush cache against entity-api

1.0.2

In this release:

-Change attribute self.header in both EntitySdk and SearchSdk to be initialized to an empty dict regardless if a token is provided or not.

-Added a single 'try' block around all of the requests inside sdk_helper.make_request() to handle bad user provided service_url's.

-Updated request library requirement in setup.py and requirements.txt to be >=2.22.0

-Updated version number to 1.0.2

1.0.1

In this release:

entitysdk.py

Additions and Removals

• Added get_prov_info(). This method mirrors the functionality of Entity Api's '/datasets/prov-info'. Returns a json containing provenance info for all primary datasets. Results may be filtered with optional arguments: has_rui_info, organ, group_uuid, and dataset_status
• Added get_prov_info_by_id. This method mirrors the functionality of Entity Api's '/datasets//prov-info'. Behaves similarly to the above method, but does not accept the additional arguments and requires a dataset id (HuBMAP ID or UUID)
• Removed get_entity_by_type(). The Entity Api endpoint called by this method is not exposed by the gateway and is inaccessible through the sdk.

Bug Fixes

• Added "X-Hubmap-Application' to create_entity(). Without these header, the endpoint was unreachable.
• Fixed a bug in get_next_revisions where it wasn't properly outputting a list object
• Fixed a bug in get_revisions_list where a key should be called "uuid" but was being called "dataset_uuid"
• Fixed a bug in get_associated_organs_from_datasets where it was labeling results as datasets rather than samples.
• Fixed spacing inconsistency in prov-info

searchsdk.py

Bug Fixes

• Fixed a bug where the default URL for searchapi was given incorrectly

sdk_helper.py

Bug Fixes

• Fixed a bug created by changes in how error messages are reported from Entity Api. In addition to errors being returned in json's with the key "error", it is now sometimes returned with the key "message". This change has been accommodated.

README.md

Minor Changes

• Incremented version number.
• Changed the dependencies to give exact versions rather than version ranges (e.g. urllib3==1.26.7 rather than urllib3>=1.26.7)

Other notes

The documents for hubmap-sdk in the softwaredocs repo have been changed to reflect the removal of get_entity_by_type() and additions of get_prov_info() and get_prov_info_by_id()

Initial Release

This is the initial release for the hubmap-sdk package. This package is hosted on PyPi and available via pip. For information on this package including how to install, see the README.