Skip to content

Commit

Permalink
v0.10.0 add note about potential breaking change
Browse files Browse the repository at this point in the history
  • Loading branch information
jjcarstens committed Mar 9, 2021
1 parent 9e6a2a8 commit 280f749
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@

* `nerves_hub_link_common 0.2.0`

* Potential Breaking Changes
* This enforces the update data structure exchanged between device and server
and is mostly internal. However, if you implement your own `NervesHubLink.Client`
behavior, then you will need to your `NervesHubLink.Client.update_available/1` to
accept a `%NervesHubLinkCommon.Message.UpdateInfo{}` struct as the parameter
instead of a map with string keys which was used until this point.

* Enhancements
* Report API version to NervesHub. While there's currently only one version of
the Device API, this is anticipation that we may want to change it in the future.
Expand Down

0 comments on commit 280f749

Please sign in to comment.