Documentation

Backward Incompatible Changes in v0.12.0

This section explains the breaking changes we're making in v0.12.0 of our client library

Suggest Edits

Core resource interfaces

Resource get methods

For all resources that are part of a project, we have updated the project_uuid argument to project. This now accepts both a UUID and a project instance.

Before v0.12.0

myst.Project.get(project_uuid=..., ...)
myst.TimeSeries.get(project_uuid=..., ...)
myst.Source.get(project_uuid=..., ...)
myst.Model.get(project_uuid=..., ...)
myst.Operation.get(project_uuid=..., ...)
myst.Backtest.get(project_uuid=..., ...)

After v0.12.0

myst.Project.get(project=..., ...)
myst.TimeSeries.get(project=..., ...)
myst.Source.get(project=..., ...)
myst.Model.get(project=..., ...)
myst.Operation.get(project=..., ...)
myst.Backtest.get(project=..., ...)

Edge classes

In an effort to further make our resource names as consistent as possible, the Input class has been split into a separate ModelInput and OperationInput class, and the Layer class has been renamed to TimeSeriesLayer. In addition, we have renamed the arguments for the methods in these classes to be more specific.

Before v0.12.0

myst.Input.create(downstream_node=..., upstream_node=..., ...)
myst.Layer.create(downstream_node=..., upstream_node=..., ...)

myst.Model.create_input(upstream_node=..., ...)
myst.Operation.create_input(upstream_node=..., ...)
myst.TimeSeries.create_layer(upstream_node=..., ...)

After v0.12.0

myst.ModelInput.create(project=..., model=..., time_series=..., ...)
myst.OperationInput.create(project=..., operation=..., time_series=..., ...)
myst.TimeSeriesLayer.create(project=..., time_series=..., node=...,... )

myst.Model.create_input(time_series=..., ...)
myst.Operation.create_input(time_series=..., ...)
myst.TimeSeries.create_layer(node=..., ...)

Updated over 2 years ago