gdombiak / OctoPod

Free open source client for OctoPrint
Apache License 2.0
225 stars 42 forks source link

OctoRelay: API v2 #661

Closed RobinTail closed 7 months ago

RobinTail commented 8 months ago

Hello @gdombiak and thank you for all the efforts you made on creating this application.

I'm a maintainer and developer of OctoRelay plugin. Your application is using the API of the plugin and I'm here to inform you on upcoming changes in this regard.

Those changes aim to establish consistency and improve the clarity. It's mostly about the I/O properties naming and error reporting.

Starting the version 3.14.0 of OctoRelay, the API v2 is introduced as an opt-in feature, which will become a default behaviour from the next major version later. Here is the Changelog entry describing them:

https://github.com/borisbu/OctoRelay/blob/master/CHANGELOG.md#3140

I presume that you're using listStatusAll and update commands. And I would like to contribute to your application in order to support that new API and help you with migration.

https://github.com/gdombiak/OctoPod/blob/f31a29db52f5e57c7f1e440489c692c0f27725b0/OctoPod/Model/Octorelay.swift#L18

Main differences:

Please let me know in case you have any questions or I could contribute in any valuable way.