소스 검색

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

docs: stop generating schema doc for 'bridges' root
Zaiming (Stone) Shi 1 년 전
부모
커밋
de5e4491f7
3개의 변경된 파일6개의 추가작업 그리고 1개의 파일을 삭제
  1. 1 1
      apps/emqx_bridge/src/schema/emqx_bridge_schema.erl
  2. 1 0
      apps/emqx_dashboard/src/emqx_dashboard_schema_api.erl
  3. 4 0
      changes/ce/breaking-12576.en.md

+ 1 - 1
apps/emqx_bridge/src/schema/emqx_bridge_schema.erl

@@ -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 - 0
apps/emqx_dashboard/src/emqx_dashboard_schema_api.erl

@@ -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 - 0
changes/ce/breaking-12576.en.md

@@ -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.