emqx_bridge_v2_api.hocon 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. emqx_bridge_v2_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. """Start bridge on all nodes in the cluster."""
  28. desc_api7.label:
  29. """Cluster Bridge Operation"""
  30. desc_api8.desc:
  31. """Start bridge on a specific node."""
  32. desc_api8.label:
  33. """Node Bridge Operation"""
  34. desc_api9.desc:
  35. """Test creating a new bridge."""
  36. desc_api9.label:
  37. """Test Bridge Creation"""
  38. desc_api10.desc:
  39. """Lists the available action types."""
  40. desc_api10.label:
  41. """List action types"""
  42. desc_api11.desc:
  43. """Lists the available source types."""
  44. desc_api11.label:
  45. """List source types"""
  46. desc_bridge_metrics.desc:
  47. """Get bridge metrics by id."""
  48. desc_bridge_metrics.label:
  49. """Get Bridge Metrics"""
  50. desc_enable_bridge.desc:
  51. """Enable or Disable bridge on all nodes in the cluster."""
  52. desc_enable_bridge.label:
  53. """Cluster Bridge Enable"""
  54. desc_param_path_enable.desc:
  55. """Whether to enable this bridge."""
  56. desc_param_path_enable.label:
  57. """Enable bridge"""
  58. desc_param_path_id.desc:
  59. """The bridge id. Must be of format {type}:{name}."""
  60. desc_param_path_id.label:
  61. """Bridge ID"""
  62. desc_qs_also_delete_dep_actions.desc:
  63. """Whether to cascade delete dependent actions."""
  64. desc_qs_also_delete_dep_actions.label:
  65. """Cascade delete dependent actions?"""
  66. desc_param_path_node.desc:
  67. """The node name, e.g. 'emqx@127.0.0.1'."""
  68. desc_param_path_node.label:
  69. """The node name"""
  70. desc_param_path_operation_cluster.desc:
  71. """Operation can be one of: 'start'."""
  72. desc_param_path_operation_cluster.label:
  73. """Cluster Operation"""
  74. desc_param_path_operation_on_node.desc:
  75. """Operation can be one of: 'start'."""
  76. desc_param_path_operation_on_node.label:
  77. """Node Operation"""
  78. }