yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(bpapi): Clarify deprecation procedure

This commit is contained in:
k32 2022-01-12 22:28:30 +01:00
parent 664be3b7d1
commit fbd7b132ca
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
apps/emqx/src/bpapi/README.md
View File

@ -96,9 +96,9 @@ The following limitations apply to these modules:
1. Once the minor EMQX release stated in `introduced_in()` callback of 1. Once the minor EMQX release stated in `introduced_in()` callback of
a module reaches GA, the module is frozen. No changes are allowed a module reaches GA, the module is frozen. No changes are allowed
there, except for adding `deprecated_since()` callback. there, except for adding `deprecated_since()` callback.
2. After the _next_ minor release after the one deprecating the 2. If the backplane API was deprecated in a release `maj.min.0`, then
module reaches GA, the module can be removed. it can be removed in release `maj.min+1.0`.
3. Old versions of the protocol can be dropped in the next major 3. Old versions of the protocols can be dropped in the next major
release. release.
This way we ensure each minor EMQX release is backward-compatible with This way we ensure each minor EMQX release is backward-compatible with

4
apps/emqx_bridge/src/emqx_bridge_api.erl
View File

@ -457,6 +457,10 @@ rpc_call(Node, Mod, Fun, Args) ->
Res -> Res Res -> Res
end. end.
wrap_rpc({badrpc, Reason}) -> {error, Reason};
wrap_rpc(Ret) -> Ret.
error_msg(Code, Msg) when is_binary(Msg) -> error_msg(Code, Msg) when is_binary(Msg) ->
#{code => Code, message => Msg}; #{code => Code, message => Msg};
error_msg(Code, Msg) -> error_msg(Code, Msg) ->