Security

• Pin certifi to an uncompromised version number. (#1440)

Security

• Pin certifi to an uncompromised version number. (#1441)

Changed

• Scope parser speed has been improved when parsing deep scope strings. (#1428)

Fixed

• Fix a RecursionError that occurs with deeply-nested request bodies. (#1423)

• Format and filter session_required_* query parameters when generating authorization URLs. (#1430)

Documentation

• All example files in the globus-sdk documentation are now required to pass type checking. Documentation examples will feature type annotations where they are instructive and clarifying. (#1422)

Added

• Add Web Input-related methods to the FlowsClient class. (#1410)
  The new methods are: list_web_inputs, get_web_input, and respond_to_web_input.

• Added a new flag, sweep, to GlobusApp.logout().
  Use logout(sweep=True) to ask the app to clear all tokens found in the app's storage, not only the ones currently in use by the app.
  The default behavior, sweep=False, is unchanged. (#1417)

Changed

• The resource_server attribute of the clients for Auth, Compute, Flows, Groups, Search, Timers, and Transfer is now annotated as str, rather than the inherited type of str | None. (#1414)

Documentation

• Remove the SpecificFlowClient.run_flow and .update_run methods' label parameter length constraint documentation. (#1408)

• Update the URL to the Flows API documentation. (#1409)

Security

• GitHub Actions security is now checked with zizmor (#1402)

Development

• globus-sdk testing now leverages Sphinx doctest to make select examples testable. (#1406)

Fixed

• Fix a crash bug in the orjson compatibility module. (#1396)

  This manifested as a RuntimeError when code inspected the module.

Added

• The SDK now supports use of orjson as an alternative JSON encoder and decoder. When orjson is installed, the SDK will automatically use it in place of the stdlib json module. (#1385)

• RequestsTransport objects are now visible via RequestsTransport.get_current_transport(), a staticmethod, while the transport is sending a request or being used to handle a response. This method raises a LookupError if there is no currently active transport. (#1385)

• The request encoders defined in globus_sdk.transport have been refactored into RequestsRepresentationProvider\s, objects responsible for encoding and decoding requests data in specific formats. In order to retain compatibility, they are still available aliased under their previous names, as "encoders". (#1385)

Removed

• The pinned field was removed from the experimental BookmarkCreateDocument and BookmarkUpdateDocument classes to align with the API, which does not support the field.

Deprecated

• The RequestsTransport class supports configuration of request encoding via a class-variable mapping, encoders. This limits the ability of the SDK to apply per-object customizations, as in the case of orjson support. The class variable encoders is deprecated. Users who wish to customize request encoding and response decoding should leverage the new representation_providers instance variable instead.

• The globus_sdk.transport.encoders module is deprecated. Use globus_sdk.transport.representation_providers instead.

Added

• Add a per_page parameter to the FlowsClient.list_registered_apis() method. (#1390)

Added

• Support for managing bookmarks via the Transfer v2 client (#1379)

• Added FlowsClient.get_registered_api(), which retrieves a registered API by ID. (#1386)

• Added FlowsClient.list_registered_apis(), which retrieves a list of registered APIs. (#1387)

Fixed

• Switch to lazy reading of response json to work with streaming responses. (#1381)

Added

• Added a new globus_sdk.experimental.gcs_downloader module which provides experimental tooling for downloading files from HTTPS GCS Collections. The new module provides a GCSDownloader class for detecting requirements and downloading files. (#1342)

• Added the experimental TransferClientV2 client class along with helper classes TunnelCreateDocument and TunnelUpdateDocument (#1370)

• JSON:API iteration and pagination is now supported through IterableJSONAPIResponse and JSONAPIPaginator (#1370)

• Added a new GCSCollectionClient class in globus_sdk.experimental.gcs_collection_client.
  The new client has no methods other than the base HTTP ones, but contains the collection ID and scopes in the correct locations for the SDK token management mechanisms to use. (#1375)

• Added support for filter_roles as a parameter to SearchClient.index_list. (#1376)

Changed

• All tunnels support in TransferClient has been labeled as Beta as the underlying API is still in development. For the most up to date interfaces it is recommended to use the TransferClientV2 (#1370)

Fixed

• Various fixes for tunnels support in TransferClient (#1370)

Fixed

• Fixed a bug in globus_sdk.TransferData which failed to convert deadline to a string when a datetime.datetime object is given. (#1372)