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

docs: fix inconsistencies for bridge and connector operations 

It's only `start` allowed for now. Also fixed some wordings.
This commit is contained in:
Stefan Strigler 2023-11-06 12:50:53 +01:00
parent f19904d43c
commit fa740a1927
4 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/emqx_bridge/src/emqx_bridge_v2_api.erl
View File

@ -301,7 +301,7 @@ schema("/nodes/:node/actions/:id/:operation") ->
'operationId' => '/nodes/:node/actions/:id/:operation', 'operationId' => '/nodes/:node/actions/:id/:operation',
post => #{ post => #{
tags => [<<"actions">>], tags => [<<"actions">>],
summary => <<"Manually start a bridge">>, summary => <<"Manually start a bridge on a given node">>,
description => ?DESC("desc_api8"), description => ?DESC("desc_api8"),
parameters => [ parameters => [
param_path_node(), param_path_node(),

2
apps/emqx_connector/src/emqx_connector_api.erl
View File

@ -288,7 +288,7 @@ schema("/nodes/:node/connectors/:id/:operation") ->
'operationId' => '/nodes/:node/connectors/:id/:operation', 'operationId' => '/nodes/:node/connectors/:id/:operation',
post => #{ post => #{
tags => [<<"connectors">>], tags => [<<"connectors">>],
summary => <<"Manually start a connector for a given node">>, summary => <<"Manually start a connector on a given node">>,
description => ?DESC("desc_api8"), description => ?DESC("desc_api8"),
parameters => [ parameters => [
param_path_node(), param_path_node(),

17
rel/i18n/emqx_bridge_v2_api.hocon
View File

@ -37,20 +37,19 @@ desc_api6.label:
"""Reset Bridge Metrics""" """Reset Bridge Metrics"""
desc_api7.desc: desc_api7.desc:
"""Stop/restart bridges on all nodes in the cluster.""" """Start bridge on all nodes in the cluster."""
desc_api7.label: desc_api7.label:
"""Cluster Bridge Operate""" """Cluster Bridge Operation"""
desc_api8.desc: desc_api8.desc:
"""Stop/restart bridges on a specific node.""" """Start bridge on a specific node."""
desc_api8.label: desc_api8.label:
"""Node Bridge Operate""" """Node Bridge Operation"""
desc_api9.desc: desc_api9.desc:
"""Test creating a new bridge by given id.</br> """Test creating a new bridge."""
The id must be of format '{type}:{name}'."""
desc_api9.label: desc_api9.label:
"""Test Bridge Creation""" """Test Bridge Creation"""
@ -62,7 +61,7 @@ desc_bridge_metrics.label:
"""Get Bridge Metrics""" """Get Bridge Metrics"""
desc_enable_bridge.desc: desc_enable_bridge.desc:
"""Enable or Disable bridges on all nodes in the cluster.""" """Enable or Disable bridge on all nodes in the cluster."""
desc_enable_bridge.label: desc_enable_bridge.label:
"""Cluster Bridge Enable""" """Cluster Bridge Enable"""
@ -92,13 +91,13 @@ desc_param_path_node.label:
"""The node name""" """The node name"""
desc_param_path_operation_cluster.desc: desc_param_path_operation_cluster.desc:
"""Operations can be one of: 'start'.""" """Operation can be one of: 'start'."""
desc_param_path_operation_cluster.label: desc_param_path_operation_cluster.label:
"""Cluster Operation""" """Cluster Operation"""
desc_param_path_operation_on_node.desc: desc_param_path_operation_on_node.desc:
"""Operations can be one of: 'start'.""" """Operation can be one of: 'start'."""
desc_param_path_operation_on_node.label: desc_param_path_operation_on_node.label:
"""Node Operation """ """Node Operation """

13
rel/i18n/emqx_connector_api.hocon
View File

@ -37,20 +37,19 @@ desc_api6.label:
"""Reset Connector Metrics""" """Reset Connector Metrics"""
desc_api7.desc: desc_api7.desc:
"""Stop/restart connectors on all nodes in the cluster.""" """Start connector on all nodes in the cluster."""
desc_api7.label: desc_api7.label:
"""Cluster Connector Operate""" """Cluster Connector Operate"""
desc_api8.desc: desc_api8.desc:
"""Stop/restart connectors on a specific node.""" """Start connector on a specific node."""
desc_api8.label: desc_api8.label:
"""Node Connector Operate""" """Node Connector Operate"""
desc_api9.desc: desc_api9.desc:
"""Test creating a new connector by given id.</br> """Test creating a new connector."""
The id must be of format '{type}:{name}'."""
desc_api9.label: desc_api9.label:
"""Test Connector Creation""" """Test Connector Creation"""
@ -62,7 +61,7 @@ desc_connector_metrics.label:
"""Get Connector Metrics""" """Get Connector Metrics"""
desc_enable_connector.desc: desc_enable_connector.desc:
"""Enable or Disable connectors on all nodes in the cluster.""" """Enable or Disable connector on all nodes in the cluster."""
desc_enable_connector.label: desc_enable_connector.label:
"""Cluster Connector Enable""" """Cluster Connector Enable"""
@ -86,13 +85,13 @@ desc_param_path_node.label:
"""The node name""" """The node name"""
desc_param_path_operation_cluster.desc: desc_param_path_operation_cluster.desc:
"""Operations can be one of: 'start' or 'stop'.""" """Operation can be one of: 'start'."""
desc_param_path_operation_cluster.label: desc_param_path_operation_cluster.label:
"""Cluster Operation""" """Cluster Operation"""
desc_param_path_operation_on_node.desc: desc_param_path_operation_on_node.desc:
"""Operations can be one of: 'start' or 'start'.""" """Operation can be one of: 'start'."""
desc_param_path_operation_on_node.label: desc_param_path_operation_on_node.label:
"""Node Operation """ """Node Operation """