Skip to content

v3.0.0 API improvements and file formats

Choose a tag to compare

@mdonoughe mdonoughe released this 15 Jan 01:22
· 28 commits to master since this release

This release changes the -f parameter to be the format of the input/output. The input file for the apply command is now specified using -i.

API Improvements

The motivation of this release was to improve the developer experience for consuming the library portion of sbz-switch. Consuming software no longer needs to be COM aware, the APIs are documented (available on docs.rs), and it is possible to specify parameters in the order they should be applied.

File Formats

The TOML format is handled using alexcrichton/toml-rs which does not support maintaining the order of table entries until the next release, so in order to support specifying parameters in order it is now possible to use JSON or YAML by specifying -f json or -f yaml.

Also, this may help with scripting, for example in PowerShell: sbz-switch dump -f json | ConvertFrom-Json | …, … | ConvertTo-Json | sbz-switch apply -f.