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

Merge pull request #12576 from zmstone/0223-hide-bridges-root-from-docs 

docs: stop generating schema doc for 'bridges' root
This commit is contained in:
Zaiming (Stone) Shi 2024-02-24 09:08:05 +01:00 committed by GitHub
parent 5af01c041b b3c7901cf2
commit de5e4491f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/emqx_bridge/src/schema/emqx_bridge_schema.erl
View File

@ -172,7 +172,7 @@ namespace() -> "bridge".
tags() -> tags() ->
[<<"Bridge">>]. [<<"Bridge">>].
roots() -> [{bridges, ?HOCON(?R_REF(bridges), #{importance => ?IMPORTANCE_LOW})}]. roots() -> [{bridges, ?HOCON(?R_REF(bridges), #{importance => ?IMPORTANCE_HIDDEN})}].
fields(bridges) -> fields(bridges) ->
[ [

1
apps/emqx_dashboard/src/emqx_dashboard_schema_api.erl
View File

@ -44,6 +44,7 @@ paths() ->
["/schemas/:name"]. ["/schemas/:name"].
%% This is a rather hidden API, so we don't need to add translations for the description. %% This is a rather hidden API, so we don't need to add translations for the description.
%% TODO(5.7): delete 'bridges'
schema("/schemas/:name") -> schema("/schemas/:name") ->
Schemas = [hotconf, bridges, actions, connectors], Schemas = [hotconf, bridges, actions, connectors],
#{ #{

4
changes/ce/breaking-12576.en.md Normal file
View File

@ -0,0 +1,4 @@
Starting from 5.6, the "Configuration Manual" document will no longer include the `bridges` config root.
A `bridge` is now either `action` + `connector` for egress data integration, or `source` + `connector` for ingress data integration.
Please note that the `bridges` config (in `cluster.hocon`) and the REST API path `api/v5/bridges` still works, but considered deprecated.