emqx_bridge_api.hocon 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. emqx_bridge_api {
  2. desc_api1.desc:
  3. """List all created bridges"""
  4. desc_api1.label:
  5. """List All Bridges"""
  6. desc_api2.desc:
  7. """Create a new bridge by type and name"""
  8. desc_api2.label:
  9. """Create Bridge"""
  10. desc_api3.desc:
  11. """Get a bridge by Id"""
  12. desc_api3.label:
  13. """Get Bridge"""
  14. desc_api4.desc:
  15. """Update a bridge by Id"""
  16. desc_api4.label:
  17. """Update Bridge"""
  18. desc_api5.desc:
  19. """Delete a bridge by Id"""
  20. desc_api5.label:
  21. """Delete Bridge"""
  22. desc_api6.desc:
  23. """Reset a bridge metrics by Id"""
  24. desc_api6.label:
  25. """Reset Bridge Metrics"""
  26. desc_api7.desc:
  27. """Stop/Restart bridges on all nodes in the cluster."""
  28. desc_api7.label:
  29. """Cluster Bridge Operate"""
  30. desc_api8.desc:
  31. """Stop/Restart bridges on a specific node."""
  32. desc_api8.label:
  33. """Node Bridge Operate"""
  34. desc_api9.desc:
  35. """Test creating a new bridge by given ID <br/>
  36. The ID must be of format '{type}:{name}'"""
  37. desc_api9.label:
  38. """Test Bridge Creation"""
  39. desc_bridge_metrics.desc:
  40. """Get bridge metrics by Id"""
  41. desc_bridge_metrics.label:
  42. """Get Bridge Metrics"""
  43. desc_enable_bridge.desc:
  44. """Enable or Disable bridges on all nodes in the cluster."""
  45. desc_enable_bridge.label:
  46. """Cluster Bridge Enable"""
  47. desc_param_path_enable.desc:
  48. """Whether to enable this bridge"""
  49. desc_param_path_enable.label:
  50. """Enable bridge"""
  51. desc_param_path_id.desc:
  52. """The bridge Id. Must be of format {type}:{name}"""
  53. desc_param_path_id.label:
  54. """Bridge ID"""
  55. desc_param_path_node.desc:
  56. """The node name, e.g. emqx@127.0.0.1"""
  57. desc_param_path_node.label:
  58. """The node name"""
  59. desc_param_path_operation_cluster.desc:
  60. """Operations can be one of: stop, restart"""
  61. desc_param_path_operation_cluster.label:
  62. """Cluster Operation"""
  63. desc_param_path_operation_on_node.desc:
  64. """Operations can be one of: stop, restart"""
  65. desc_param_path_operation_on_node.label:
  66. """Node Operation"""
  67. }