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:
commit
de5e4491f7
|
@ -172,7 +172,7 @@ namespace() -> "bridge".
|
|||
tags() ->
|
||||
[<<"Bridge">>].
|
||||
|
||||
roots() -> [{bridges, ?HOCON(?R_REF(bridges), #{importance => ?IMPORTANCE_LOW})}].
|
||||
roots() -> [{bridges, ?HOCON(?R_REF(bridges), #{importance => ?IMPORTANCE_HIDDEN})}].
|
||||
|
||||
fields(bridges) ->
|
||||
[
|
||||
|
|
|
@ -44,6 +44,7 @@ paths() ->
|
|||
["/schemas/:name"].
|
||||
|
||||
%% 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") ->
|
||||
Schemas = [hotconf, bridges, actions, connectors],
|
||||
#{
|
||||
|
|
|
@ -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.
|
Loading…
Reference in New Issue